Contract http://schemas.sage.com/sageSchemas/2011

Resource Kind

Plural

Compliance

CanGet

CanPost

CanPut

CanDelete

isSyncSource

isSyncTarget

operatingCompany

operatingCompanies

must

true 

 

 

 

 

 

person

people

must

true 

true 

true 

true 

 

 

postalAddress

postalAddresses

must

true 

true 

true 

true 

true 

true 

email

emails

must

true 

true 

true 

true 

true 

true 

phoneNumber

phoneNumbers

must

true 

true 

true 

true 

true 

true 

note

notes

may

true 

 

 

 

 

 

financialAccount

financialAccounts

may

true 

 

 

 

 

 

costCentre

costCentres

may

true 

 

 

 

 

 

department

departments

may

true 

 

 

 

 

 

financialAccountAnalysis

financialAccountAnalysis

may

true 

 

 

 

 

 

financialAccountGroup

financialAccountGroups

may

true 

 

 

 

 

 

financialAccountHistory

financialAccountsHistory

may

true 

 

 

 

 

 

financialAccountMultiCurrencyHistory

financialAccountsMultiCurrencyHistory

may

true 

 

 

 

 

 

financialAccountBudget

financialAccountsBudget

may

true 

 

 

 

 

 

financialPeriod

financialPeriods

should

true 

 

 

 

 

 

financialAccountBudgetType

financialAccountBudgetType

may

true 

 

 

 

 

 

tradingAccount

tradingAccounts

must

true 

true 

true 

true 

true 

true 

contact

contacts

must

true 

true 

true 

true 

true 

true 

contactGroup

contactGroups

may

true 

 

 

 

 

 

salesOrder

salesOrders

should

true 

true 

true 

 

true 

true 

salesOrderLine

salesOrderLines

should

true 

true 

true 

 

true 

true 

salesQuotation

salesQuotations

should

true 

true 

true 

 

true 

true 

salesQuotationLine

salesQuotationLines

should

true 

true 

true 

 

true 

true 

commodity

commodities

must

true 

 

 

 

true 

 

commodityGroup

commodityGroups

must

true 

 

 

 

true 

 

priceList

priceLists

must

true 

 

 

 

true 

 

price

prices

must

true 

 

 

 

true 

 

unitOfMeasure

unitsOfMeasure

must

true 

 

 

 

true 

 

opportunity

opportunities

may

true 

 

 

 

 

 

interaction

interactions

may

true 

 

 

 

 

 

salesInvoice

salesInvoices

should

true 

true 

true 

 

 

 

salesInvoiceLine

salesInvoiceLines

should

true 

true 

true 

 

 

 

salesCredit

salesCredits

should

true 

true 

true 

 

 

 

salesCreditLine

salesCreditLines

should

true 

true 

true 

 

 

 

salesReturn

salesReturns

should

true 

true 

true 

 

 

 

salesReturnLine

salesReturnLines

should

true 

true 

true 

 

 

 

salesOrderDelivery

salesOrderDeliveries

may

true 

 

 

 

 

 

salesOrderDeliveryLine

salesOrderDeliveryLines

may

true 

 

 

 

 

 

salesReturnDelivery

salesReturnDeliveries

may

true 

 

 

 

 

 

salesReturnDeliveryLine

salesReturnDeliveryLines

may

true 

 

 

 

 

 

purchaseOrder

purchaseOrders

may

true 

true 

 

 

 

 

purchaseOrderLine

purchaseOrderLines

may

true 

true 

 

 

 

 

purchaseRequisition

purchaseRequisitions

may

true 

true 

 

 

 

 

purchaseRequisitionLine

purchaseRequisitionLines

may

true 

true 

 

 

 

 

purchaseInvoice

purchaseInvoices

may

true 

true 

 

 

 

 

purchaseInvoiceLine

purchaseInvoiceLines

may

true 

true 

 

 

 

 

purchaseCredit

purchaseCredits

may

true 

 

 

 

 

 

purchaseCreditLine

purchaseCreditLines

may

true 

 

 

 

 

 

purchaseReturn

purchaseReturns

may

true 

 

 

 

 

 

purchaseReturnLine

purchaseReturnLines

may

true 

 

 

 

 

 

purchaseOrderDelivery

purchaseOrderDeliveries

may

true 

 

 

 

 

 

purchaseOrderDeliveryLine

purchaseOrderDeliveryLines

may

true 

 

 

 

 

 

purchaseReturnDelivery

purchaseReturnDeliveries

may

true 

 

 

 

 

 

purchaseReturnDeliveryLine

purchaseReturnDeliveryLines

may

true 

 

 

 

 

 

receipt

receipts

may

true 

 

 

 

 

 

receiptLine

receiptLines

may

true 

 

 

 

 

 

payment

payments

may

true 

 

 

 

 

 

paymentLine

paymentLines

may

true 

 

 

 

 

 

project

projects

may

true 

 

 

 

 

 

projectLine

projectLines

may

true 

 

 

 

 

 

bankAccount

bankAccounts

may

true 

 

 

 

 

 

location

locations

may

true 

 

 

 

 

 

commodityIdentifier

commodityIdentifiers

should

true 

 

 

 

 

 

salesPerson

salesPersons

may

 

 

 

 

 

 

commodityDimension

commodityDimensions

may

 

 

 

 

 

 

commodityVariant

commodityVariants

may

 

 

 

 

 

 

case

cases

may

true 

 

 

 

 

 

taxCode

taxCodes

should

true 

 

 

 

 

 

computePrice

 

 

 

 

 

 

organization

organizations

may

true 

true 

true 

true 

 

 

position

positions

may

true 

true 

true 

true 

 

 

vacancy

vacancies

may

true 

true 

true 

true 

 

 

employee

employees

must

true 

true 

true 

true 

 

 

employeeGroup

employeeGroups

may

true 

true 

true 

true 

 

 

employment

employments

should

true 

true 

true 

true 

 

 

candidate

candidates

may

true 

true 

true 

true 

 

 

competency

competencies

may

true 

true 

true 

true 

 

 

competencyGroup

competencyGroups

may

true 

true 

true 

true 

 

 

workplace

workplaces

should

true 

true 

true 

true 

 

 

resume

resumes

may

true 

true 

true 

true 

 

 

timesheet

timesheets

should

true 

true 

true 

true 

 

 

timesheetLine

timesheetLines

should

true 

true 

true 

true 

 

 

expenseClaim

expenseClaims

may

true 

true 

true 

true 

 

 

expenseClaimLine

expenseClaimLines

may

true 

true 

true 

true 

 

 

benefit

benefits

should

true 

true 

true 

true 

 

 

vehicle

vehicles

may

true 

true 

true 

true 

 

 

payroll

payrolls

should

true 

true 

true 

true 

 

 

payrollLine

payrollLines

should

true 

true 

true 

true 

 

 

payrollGroup

payrollGroups

may

true 

true 

true 

true 

 

 

payslip

payslips

may

true 

true 

true 

true 

 

 

payslipLine

payslipLines

may

true 

true 

true 

true 

 

 

objective

objectives

should

true 

true 

true 

true 

 

 

appraisal

appraisals

should

true 

true 

true 

true 

 

 

disciplinary

disciplinaries

may

true 

true 

true 

true 

 

 

incident

incidents

may

true 

true 

true 

true 

 

 

training

trainings

should

true 

true 

true 

true 

 

 

trainingEvent

trainingEvents

should

true 

true 

true 

true 

 

 

trainingRegister

trainingRegisters

should

true 

true 

true 

true 

 

 

trainingGroup

trainingGroups

may

true 

true 

true 

true 

 

 

workTime

workTimes

may

true 

true 

true 

true 

 

 

workTimeLine

workTimeLines

may

true 

true 

true 

true 

 

 

absence

absences

should

true 

true 

true 

true 

 

 

absenceLine

absenceLines

should

true 

true 

true 

true 

 

 

relatedParty

relatedParties

should

true 

true 

true 

true 

 

 

payrollElement

payrollElements

should

true 

true 

true 

true 

 

 

expenseCategory

expenseCategories

may

true 

true 

true 

true 

 

 

rate

rates

should

true 

true 

true 

true 

 

 

fixedAsset

fixedAssets

must

true 

true 

true 

true 

 

 

fixedAssetGroup

fixedAssetGroups

may

true 

true 

true 

true 

 

 

fixedAssetSchedule

fixedAssetSchedules

should

true 

true 

true 

true 

 

 

fixedAssetEvent

fixedAssetEvents

should

true 

true 

true 

true 

 

 

financialAccountJournal

financialAccountJournals

should

true 

true 

true 

true 

 

 

financialAccountJournalLine

financialAccountJournalLines

should

true 

true 

true 

true 

 

 

lease

leases

may

true 

true 

true 

true 

 

 

grant

grants

may

true 

true 

true 

true 

 

 

Top  

Resource operatingCompany

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Operating Company Active Flag

 

 

 

 

 

Flag to indicate if the Company is an active Company. Default = True  

name

normalizedString

Operating Company Name

 

 

 

X

 

The entity name (e.g. Home-style Kitchens).  

shortName

normalizedString

Operating Company Short Name

 

X

 

 

 

A shorter name for the Company.  

currency

normalizedString

Operating Company Currency

 

X

 

 

 

The Company currency (e.g. GBP, USD, EUR). ISO 4217  

identifier

normalizedString

Operating Company Identifier

X

X

 

 

 

Identifier(s) of the Company as used by the third parties (e.g. Company Registration Number, DUNS number, 1099 type, CIS number, siret number, Trading Number, etc).  

taxLocale

normalizedString

Operating Company Tax Locale

 

 

 

 

 

The tax-locale applicable to the Operating Company (e.g. District)  

taxReference

normalizedString

Operating Company Tax Reference

X

X

 

 

 

Tax reference associated with the Company (e.g. VAT number, numero intracommnunautaire, FEIN) NIF (Spain)  

language

normalizedString

Operating Company Language

 

X

 

 

 

Language used by the Company (e.g. EN-GB) ISO 639-1  

postalAddresses

postalAddress*

Operating Company Postal Addresses

 

 

 

 

child 

Postal address(es) associated with the Operating Company. See PostalAddress definition.  

phoneNumbers

phoneNumber*

Operating Company Phone Numbers

 

 

 

 

child 

Phone numbers associated with the Operating Company. See PhoneNumber definition.  

legalEntityType

operatingCompanyLegalEntityType

Operating Company Legal Entity Type

 

 

 

 

 

The type of legal business entity the Operating Company is, e.g. Partnership, Limited Company, etc.  

paymentIdentifier

string

Operating Company Payment (Processing) Identifier

X

X

 

 

 

Identifier(s) of the Company as used by the payment processing provider.    

bankAccount

bankAccount*

Operating Company BankAccount

 

X

 

 

association 

Bank account(s) associated with the Operating Company. Used when monies are transferred by bank-to-bank transfer (e.g. BACS/ACS). This is the bank account into which customer monies are paid or from which customer monies are refunded (or vice-versa for suppliers/vendors).  

Top  

Resource person

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

Top  

Resource postalAddress

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PostalAddress Active Flag

 

 

 

 

 

Flag to indicate if the Postal Address is an active one. Default = True  

reference

normalizedString

PostalAddress Reference

X

 

 

 

 

Reference for the Postal Address. 

name

normalizedString

PostalAddress Name

 

X

 

 

 

A name for the Postal Address (e.g. Billing Address).  

description

string

PostalAddress Description

 

X

 

 

 

A longer description of the postal Postal Address.  

address1

normalizedString

PostalAddress Address 1

 

X

 

 

 

1st Line of Postal Address 

address2

normalizedString

PostalAddress Address 2

 

X

 

 

 

2nd Line of Postal Address 

address3

normalizedString

PostalAddress Address 3

 

X

 

 

 

3rd Line of Postal Address 

address4

normalizedString

PostalAddress Address 4

 

X

 

 

 

4th Line of Postal Address 

townCity

normalizedString

PostalAddress TownCity

 

X

 

 

 

Town or City 

county

normalizedString

PostalAddress County

 

X

 

 

 

County 

stateRegion

normalizedString

PostalAddress StateRegion

 

X

 

 

 

State/Region. For USA addresses use ISO 3166-2:US for state codes. For UK addresses use ISO 3166-2:GB. For French addresses use ISO 3166-2:FR. For German addresses use ISO 3166-2:DE. For Canada addresses use ISO 3166-2:CA.  

zipPostCode

normalizedString

PostalAddress ZipPost Code

 

X

 

 

 

Zip or Post code. Should be formatted as raw text no formatting included.  

country

normalizedString

PostalAddress Country

 

X

 

 

 

Country. ISO 3166-1 alpha-2 country codes only 

primacyIndicator

boolean

PostalAddress Primacy Indicator

 

 

 

 

 

A flag to indicate if the Address is the primary/default Address. Only one Postal Address can have Primacy against an associated entity (e.g. Contact, Company, etc). Default = False  

type

postalAddressType

PostalAddress Type

 

 

 

X

 

The type of the Postal Address, e.g., billing, sales address, home, etc. A new Postal Address will be required for each type, even though the address itself may be the same. Default = Correspondence  

notes

note*

PostalAddress Notes

 

X

 

 

child 

Notes associated with the Postal Address. 

Top  

Resource email

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Email Active Flag

 

 

 

 

 

Flag to indicate if the Email is an active one. Default = True  

reference

normalizedString

Email Reference

X

 

 

 

 

Reference associated with the Email. 

reference2

normalizedString

Email Reference2

 

X

 

 

 

Another reference associated with the email. 

type

emailType

Email Type

 

 

 

 

 

A simple string value used to label this email address. It allows for email addresses such as Work, Personal, Preferred, etc. Can also be used to distinguish instant messaging type addresses.  

address

normalizedString

Email Address

 

 

 

X

 

The Email address itself (e.g. joe.bloggs@acme.com).  

url

normalizedString

mailto:URL

X

 

 

 

 

URL that allows an email to be automatically generated that is to be set to the email address. Could be created automatically.  

primacyIndicator

boolean

Email Primacy Indicator

 

 

 

 

 

Flag to indicate if this Email is the primary one associated with the linked resource. Default = False  

notes

note*

Email Notes

 

X

 

 

child 

Notes associated with email. 

Top  

Resource phoneNumber

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PhoneNumber Active Flag

 

 

 

 

 

Flag to indicate if the phone number is an active one. Default = True  

reference

normalizedString

PhoneNumber Reference

X

 

 

 

 

Reference associated with the phone number. 

reference2

normalizedString

PhoneNumber Reference2

 

X

 

 

 

Another reference associated with the phone number.  

uri

normalizedString

PhoneNumber URI

X

 

 

 

 

A phone unique reference number used to represent the number in a formal way. Useful for programmatic access, such as a VoIP/PSTN/CTI. Could be derived by concatenating attributes.  

type

phoneNumberType

PhoneNumber Type

 

 

 

 

 

A value that identifies the type of phone number (general, fax, car, home, internal, mobile, other, pager, satellite, VoIP, work).  

name

normalizedString

PhoneNumber Name

 

X

 

 

 

A simple string value used to label this phone number. In most cases, Label is not necessary as Phone Type uniquely identifies a number and allows UIs to display a proper label such as Mobile, Home, Work, etc. However, in the case where one person has (for example) multiple mobile phones, this property can be used to disambiguate them. Could be derived from Phone Type  

text

normalizedString

PhoneNumber Text

 

 

 

X

 

Human-readable phone number, containing all attributes. Could be derived by concatenating other properties.  

countryCode

normalizedString

PhoneNumber Country Code

 

 

 

 

 

Country code for the phone number based on ITU-T recommendation E.164 country codes. ITU-T E. 164 country codes only.  

areaCode

normalizedString

PhoneNumber Area Code

 

 

 

 

 

Area code for the phone number 

number

normalizedString

PhoneNumber Number

 

 

 

 

 

Telephone number. 

extension

normalizedString

PhoneNumber Extension

 

X

 

 

 

Any extension applicable to the phone number. 

primacyIndicator

boolean

PhoneNumber Primacy Indicator

 

 

 

 

 

Flag to indicate if this Phone Number is the primary one associated with the linked resource. Default = False  

notes

note*

PhoneNumber Note

 

X

 

 

child 

Notes associated with phone number. 

Top  

Resource note

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Note Active Flag

 

 

 

 

 

Flag to indicate if the note is an active one. Default = True  

reference

normalizedString

Note Reference

X

 

 

 

 

Reference associated with the note. 

reference2

normalizedString

Note Reference2

 

X

 

 

 

Another reference associated with the note. 

text

string

Note Text

 

 

 

X

 

The note text itself. 

privacyFlag

boolean

Note Privacy Flag

 

 

 

 

 

Flag to indicate if the note is public or private. Default = No (not private).  

dateStamp

date

Note Date Stamp

 

 

 

 

 

Date and time of note 

primacyIndicator

boolean

Note Primacy Indicator

 

 

 

 

 

Flag to indicate if this Note is the primary one associated with the linked resource. Default = False  

user

normalizedString

Note User

 

 

 

 

 

Details of the user who created the note. 

Top  

Resource financialAccount

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

financialAccountGroups

financialAccountGroup*

FinancialAccount Groups

 

X

 

 

association 

Link to the Financial Account Group associated with this Financial Account See Financial Account Group definition.  

active

boolean

FinancialAccount Active Flag

 

 

 

 

 

Flag to indicate if the FinancialAccount is an active one. Default = True  

reference

normalizedString

FinancialAccount Reference

X

 

 

 

 

Reference associated with the Financial Account. 

reference2

normalizedString

FinancialAccount Reference2

 

X

 

 

 

Another reference associated with the Financial Account.  

accountCategory

financialAccountAccountCategory

FinancialAccount Account Category

 

X

 

 

 

The account category applicable to the FinancialAccount (see enum for list of values). Account categories classify each account into major accounting categories for financial reporting. Implementation teams should try and map to these where possible (based on IFRS/GAAP so should be common). However the list can be extended to add other account categories. 

accountType

financialAccountAccountType

FinancialAccount Account Type

 

X

 

 

 

The account type applicable to the FinancialAccount (see enum for list of values). Implementation teams should try and map to these where possible (based on IFRS/GAAP so should be common). However the list can be extended to add other account types. 

postingType

financialAccountPostingType

FinancialAccount Posting Type

 

X

 

 

 

The type of posting applicable to the FinancialAccount (memo, posting, grouping). Default = Posting. Memo accounts are not posting accounts - they are used to show text only, e.g. for reporting purposes. Grouping accounts are super-types used to group other accounts together, e.g. all sales accounts. Posting accounts receive financial postings  

reportingType

financialAccountReportingType

FinancialAccount Reporting Type

 

X

 

 

 

The reporting type applicable to the Financial Account (P&L or BS). Default = Unknown  

accountingType

financialAccountAccountingType

FinancialAccount Accounting Type

 

X

 

 

 

A flag that indicates the type of accounting applicable to the Financial Account. Default = Unknown  

name

normalizedString

FinancialAccount Name

 

 

 

 

 

The name of the FinancialAccount (e.g. Cost of sales, Inventory, Debtors Control, etc).  

description

string

FinancialAccount Description

 

X

 

 

 

A longer textual description of the FinancialAccount.  

account

normalizedString

FinancialAccount Account

 

X

 

 

 

Financial accounting code or natural account. 

costCentres

costCentre*

FinancialAccount Cost Centres

 

X

 

 

association 

Analysis code (cost centre) applicable to the financial account. If cost centres are used, then they should be used here.  

departments

department*

FinancialAccount Departments

 

X

 

 

association 

Analysis code (department) applicable to the financial account. If departments are used, then they should be used here.  

analysis01

financialAccountAnalysis*

FinancialAccount Analysis 01

 

X

 

 

association 

Analysis code (1) applicable to the financial account. E.g. COA segment 1  

analysis02

financialAccountAnalysis*

FinancialAccount Analysis 02

 

X

 

 

association 

Analysis code (2) applicable to the financial account. E.g. COA segment 2  

analysis03

financialAccountAnalysis*

FinancialAccount Analysis 03

 

X

 

 

association 

Analysis code (3) applicable to the financial account. E.g. COA segment 3  

analysis04

financialAccountAnalysis*

FinancialAccount Analysis 04

 

X

 

 

association 

Analysis code (4) applicable to the financial account. E.g. COA segment 4  

analysis05

financialAccountAnalysis*

FinancialAccount Analysis 05

 

X

 

 

association 

Analysis code (5) applicable to the financial account. E.g. COA segment 5  

analysis06

financialAccountAnalysis*

FinancialAccount Analysis 06

 

X

 

 

association 

Analysis code (6) applicable to the financial account. E.g. COA segment 6  

analysis07

financialAccountAnalysis*

FinancialAccount Analysis 07

 

X

 

 

association 

Analysis code (7) applicable to the financial account. E.g. COA segment 7  

analysis08

financialAccountAnalysis*

FinancialAccount Analysis 08

 

X

 

 

association 

Analysis code (8) applicable to the financial account. E.g. COA segment 8  

analysis09

financialAccountAnalysis*

FinancialAccount Analysis 09

 

X

 

 

association 

Analysis code (9) applicable to the financial account. E.g. COA segment 9  

analysis10

financialAccountAnalysis*

FinancialAccount Analysis 10

 

X

 

 

association 

Analysis code (10) applicable to the financial account. E.g. COA segment 10  

analysis11

financialAccountAnalysis*

FinancialAccount Analysis 11

 

X

 

 

association 

Analysis code (11) applicable to the financial account. E.g. COA segment 11  

analysis12

financialAccountAnalysis*

FinancialAccount Analysis 12

 

X

 

 

association 

Analysis code (12) applicable to the financial account. E.g. COA segment 12  

analysis13

financialAccountAnalysis*

FinancialAccount Analysis 13

 

X

 

 

association 

Analysis code (13) applicable to the financial account. E.g. COA segment 13  

analysis14

financialAccountAnalysis*

FinancialAccount Analysis 14

 

X

 

 

association 

Analysis code (14) applicable to the financial account. E.g. COA segment 14  

analysis15

financialAccountAnalysis*

FinancialAccount Analysis 15

 

X

 

 

association 

Analysis code (15) applicable to the financial account. E.g. COA segment 15  

naturalBalanceType

financialAccountNaturalBalanceType

FinancialAccount Natural Balance Type

 

X

 

 

 

A flag that indicates the natural balance of the Financial Account - Debit or Credit. Used to show correct Positive/Negative balance values. 

financialAccountHistories

financialAccountHistory*

FinancialAccount Histories

 

X

 

 

association 

Financial Account History (balances, stats) associated with this Financial Account. The financialAccountHistory resource may be current or historic.  

multiCurrencyPostingAllowed

boolean

FinancialAccount Multi-Currency Posting Allowed Flag

 

 

 

 

 

Flag to indicate if this Financial Account is allowed to have postings in multiple currencies. Default = False (posting in single currency). If this is true then the Financial Account should have financialAccountMultiCurrencyHistory feeds associated with it.  

currencyRestriction

financialAccountCurrencyRestriction

FinancialAccount Currency Restriction

 

X

 

 

 

For accounts where multi-currency posting is allowed, this enum shows what type of currency restrictions apply to the account. Options are base currency only, base currency and one other, all currencies. Default = All Currencies. 

financialAccountMultiCurrencyHistories

financialAccountMultiCurrencyHistory*

FinancialAccount Multi-Currency Histories

 

X

 

 

association 

Multi-Currency Financial Account History (balances, stats) associated with this Financial Account. Only if multiCurrencyPostingAllowed=True. The financialAccountMultiCurrencyHistory resource may be current or historic.  

financialAccountBudgets

financialAccountBudget*

FinancialAccount Budgets

 

X

 

 

association 

Budget (balances, stats) associated with this Financial Account. 

primacyIndicator

boolean

FinancialAccount Primacy Indicator

 

 

 

 

 

Flag to indicate if this Financial Account is the primary Financial Account in cases where there are multiple. Default = False  

allowStats

boolean

FinancialAccount Allow Statistics Flag

 

X

 

 

 

Flag to indicate if this FinancialAccount can also be used to track statistical data. Default = False  

statUnit

normalizedString

FinancialAccount Statistical Unit

 

X

 

 

 

A text description of the statistical unit associated with this account (if allowStats=True). Examples of stats include headcount, number of, etc.  

orderOfPrecedence

decimal

FinancialAccount Order Of Precedence

 

X

 

 

 

Where there are multiple Financial Accounts (e.g. in a Group) then this field will be used to sort the order of precedence/application. 

distributionPercentage

decimal

FinancialAccount Distribution Percentage

 

X

 

 

 

Distribution percentage applicable to the Financial Account (e.g. where a collection of Financial Accounts are associated with an amount, this figure determines the percentage split, e.g. 80% to this account). 

createDate

date

FinancialAccount Create Date

 

X

 

 

 

The date the financial account was created. 

notes

note*

FinancialAccount Note

 

X

 

 

child 

Note associated with the FinancialAccount. See Note definition.  

Top  

Resource costCentre

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

CostCentre Active Flag

 

 

 

 

 

Flag to indicate if the costCentre is an active one. Default = True  

reference

normalizedString

CostCentre Reference

X

 

 

 

 

Reference associated with the Financial Account. 

reference2

normalizedString

CostCentre Reference2

 

X

 

 

 

Another reference associated with the Financial Account.  

type

normalizedString

CostCentre Type

 

X

 

 

 

The type of the costCentre  

name

normalizedString

CostCentre Name

 

 

 

 

 

The name of the costCentre  

description

string

CostCentre Description

 

X

 

 

 

A longer textual description of the costCentre.  

notes

note*

CostCentre Note

 

X

 

 

child 

Note associated with the costCentre. See Note definition.  

Top  

Resource department

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Department Active Flag

 

 

 

 

 

Flag to indicate if the Department is an active one. Default = True  

reference

normalizedString

Department Reference

X

 

 

 

 

Reference associated with the Financial Account. 

reference2

normalizedString

Department Reference2

 

X

 

 

 

Another reference associated with the Financial Account.  

type

normalizedString

Department Type

 

X

 

 

 

The type of the Department  

name

normalizedString

Department Name

 

 

 

 

 

The name of the Department  

description

string

Department Description

 

X

 

 

 

A longer textual description of the Department.  

notes

note*

Department Note

 

X

 

 

child 

Note associated with the Department. See Note definition.  

Top  

Resource financialAccountAnalysis

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Financial Account Analysis Active Flag

 

 

 

 

 

Flag to indicate if the Financial Account Analysis (code) is an active one. Default = True  

reference

normalizedString

Financial Account Analysis Reference

X

 

 

 

 

Reference associated with the Financial Account Analysis (code). 

reference2

normalizedString

Financial Account Analysis Reference2

 

X

 

 

 

Another reference associated with the Financial Account Analysis (code).  

type

financialAccountAnalysisType

Financial Account Analysis Type

 

X

 

 

 

The type of the Financial Account Analysis (code) Used to indicate if this Financial Account Analysis (code) is also the natural account. Allowable values Natural, Other.  

name

normalizedString

Financial Account Analysis Name

 

 

 

 

 

The name of the Financial Account Analysis (code)  

description

string

Financial Account Analysis Description

 

X

 

 

 

A longer textual description of Financial Account Analysis (code).  

notes

note*

Financial Account Analysis Note

 

X

 

 

child 

Note associated with the Financial Account Analysis (code). See Note definition.  

Top  

Resource financialAccountGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

FinancialAccountGroup Active Flag

 

 

 

 

 

Flag to indicate if the Financial Account Group is an active one. Default = True  

reference

normalizedString

FinancialAccountGroup Reference

X

 

 

 

 

Reference for the Financial Account Group. 

name

normalizedString

FinancialAccountGroup Name

 

 

 

X

 

Name of the Financial Account Group. 

description

string

FinancialAccountGroup Description

 

X

 

 

 

A longer description of the Financial Account Group. 

orderOfPrecedence

decimal

FinancialAccountGroup Order Of Precedence

 

X

 

 

 

Where there are multiple Financial Account Groups then this field will be used to sort the order of precedence/application (e.g. for reporting). 

financialAccounts

financialAccount*

FinancialAccountGroup FinancialAccount

 

X

 

 

association 

Financial Accounts associated with the FinancialAccount Group. See Financial Account definition. FinancialAccounts can belong to multiple FinancialAccount Groups.  

notes

note*

FinancialAccountGroup Note

 

X

 

 

child 

Notes associated with a Financial Account Group. 

accountGroupType

financialAccountGroupType

Financial Account Group Type

 

X

 

 

 

The Financial Account Group type applicable to this Financial Account Group, e.g. Layout, Category, Unknown, Other. Implementation teams should try and map to these where possible. However the list can be extended to add other account types. 

parentFinancialAccountGroup

financialAccountGroup

Financial Account Group Parent Financial Account Group

 

X

 

 

parent 

Link to a Financial Account Group which is the Parent of this Financial Account Group (e.g. Categories Ranges, Layouts etc).  

childFinancialAccountGroups

financialAccountGroup*

Financial Account Group Child Financial Account Groups

 

X

 

 

child 

Link to any Financial Account Groups that this Financial Account Group is the parent of.  

Top  

Resource financialAccountHistory

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

financialAccount

financialAccount

FinancialAccountHistory Financial Account

 

X

 

 

reference 

Link to the Financial Account associated with this Financial Account History See Financial Account definition.  

financialPeriods

financialPeriod*

FinancialAccountHistory Financial Periods

 

X

 

 

association 

Link to the Financial Period(s) associated with this Financial Account History. A combination of Financial Account and Financial Period allows all financial history to be reported.  

active

boolean

FinancialAccountHistory Active Flag

 

 

 

 

 

Flag to indicate if the FinancialAccountHistory is an active one. Default = True  

reference

normalizedString

FinancialAccountHistory Reference

X

 

 

 

 

Reference associated with the Financial Account History. 

reference2

normalizedString

FinancialAccountHistory Reference2

 

X

 

 

 

Another reference associated with the Financial Account History.  

name

normalizedString

FinancialAccountHistory Name

 

 

 

 

 

The name of the FinancialAccountHistory (e.g. Q1 2010, Q2 2010, etc).  

description

string

FinancialAccountHistory Description

 

X

 

 

 

A longer textual description of the FinancialAccountHistory.  

currency

normalizedString

FinancialAccountHistory Currency

 

 

 

 

 

The financial account history currency (e.g. GBP, USD, EUR). ISO 4217. This should be in the base currency of the operating company. 

balance

decimal

FinancialAccountHistory (Closing) Balance

 

X

 

 

 

The financial account history balance in the financial account history currency. If this is a summary feed then this is the closing balance for the financial period concerned.  

balanceDate

date

FinancialAccountHistory (Closing) Balance Date

 

X

 

 

 

The date upon which the balance was based. Default to system date if not used.  

openingBalance

decimal

FinancialAccountHistory Opening Balance

 

X

 

 

 

FinancialAccountHistory opening balance. In FinancialAccountHistory currency. For summary feeds only. This is the opening balance for the financial period concerned. 

debitPostingAmount

decimal

FinancialAccountHistory Debit Posting Amount

 

X

 

 

 

FinancialAccountHistory debit posting amount. In FinancialAccountHistory currency. For summary feeds only. This is the debit amount posted to the account for the financial period concerned. 

creditPostingAmount

decimal

FinancialAccountHistory Credit Posting Amount

 

X

 

 

 

FinancialAccountHistory Credit posting amount. In FinancialAccountHistory currency. For summary feeds only. This is the credit amount posted to the account for the financial period concerned. 

lastTransactionDate

date

FinancialAccountHistory Last Transaction Date

 

X

 

 

 

Date the last transaction was posted to the FinancialAccountHistory account.  

primacyIndicator

boolean

FinancialAccountHistory Primacy Indicator

 

 

 

 

 

Flag to indicate if this FinancialAccountHistory is the primary (current) one.  

statOpeningBalance

decimal

FinancialAccountHistory Statistical Opening Balance

 

X

 

 

 

FinancialAccountHistory stat opening balance. In FinancialAccount stat unit. For summary feeds only. This is the opening statistical balance for the financial period concerned. 

statAmount

decimal

FinancialAccountHistory Statistical Amount

 

X

 

 

 

FinancialAccountHistory stat amount. In FinancialAccount stat unit. For summary feeds only. This is the amount of stat unit for the account for the financial period concerned. 

statClosingBalance

decimal

FinancialAccountHistory Statistical Closing Balance

 

X

 

 

 

FinancialAccountHistory stat closing balance. In FinancialAccountHistory stat unit. For summary feeds only. This is the closing statistical balance for the financial period concerned. 

Top  

Resource financialAccountMultiCurrencyHistory

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

financialAccount

financialAccount

FinancialAccountMultiCurrencyHistory Financial Account

 

X

 

 

reference 

Link to the Financial Account associated with this Financial Account Multi-Currency History. See Financial Account definition.  

financialPeriods

financialPeriod*

FinancialAccountMultiCurrencyHistory Financial Periods

 

X

 

 

association 

Link to the Financial Period(s) associated with this FinancialAccountMultiCurrencyHistory. A combination of Financial Account and Financial Period and Currency allows all financial history to be reported in all currencies.  

active

boolean

FinancialAccountMultiCurrencyHistory Active Flag

 

 

 

 

 

Flag to indicate if the FinancialAccountMultiCurrencyHistory is an active one. Default = True  

reference

normalizedString

FinancialAccountMultiCurrencyHistory Reference

X

 

 

 

 

Reference associated with the FinancialAccountMultiCurrencyHistory. 

reference2

normalizedString

FinancialAccountMultiCurrencyHistory Reference2

 

X

 

 

 

Another reference associated with the FinancialAccountMultiCurrencyHistory.  

name

normalizedString

FinancialAccountMultiCurrencyHistory Name

 

 

 

 

 

The name of the FinancialAccountMultiCurrencyHistory (e.g. Q1 2010 USD, Q2 2010 GBP, etc).  

description

string

FinancialAccountMultiCurrencyHistory Description

 

X

 

 

 

A longer textual description of the FinancialAccountMultiCurrencyHistory.  

currency

normalizedString

FinancialAccountMultiCurrencyHistory Currency

 

 

 

 

 

The FinancialAccountMultiCurrencyHistory currency (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

FinancialAccountMultiCurrencyHistory OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base or home currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

FinancialAccountMultiCurrencyHistory OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from FinancialAccountMultiCurrencyHistory into FinancialAccountMultiCurrencyHistory OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

FinancialAccountMultiCurrencyHistory OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from FinancialAccountMultiCurrencyHistory Currency to FinancialAccountMultiCurrencyHistory OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is amounts in FinancialAccountMultiCurrencyHistory Currency / FinancialAccountMultiCurrencyHistory OperatingCompanyCurrencyExchange Rate = amounts in FinancialAccountMultiCurrencyHistory OperatingCompanyCurrency.  

operatingCompanyCurrencyExchangeRateDate

date

FinancialAccountMultiCurrencyHistory OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from FinancialAccountMultiCurrencyHistory Currency to FinancialAccountMultiCurrencyHistory OperatingCompanyCurrency, if different. Default = System date  

balance

decimal

FinancialAccountMultiCurrencyHistory (Closing) Balance

 

X

 

 

 

The financial account multi-currency history balance in the financial account multi-currency history currency. If this is a summary feed then this is the closing balance for the financial period concerned.  

balanceOperatingCompanyCurrency

decimal

FinancialAccountMultiCurrencyHistory (Closing) Balance (Operating Company Currency)

 

X

 

 

 

The financial account multi-currency history balance in the operating company (base/home) currency. If this is a summary feed then this is the closing balance for the financial period concerned.  

balanceDate

date

FinancialAccountMultiCurrencyHistory (Closing) Balance Date

 

X

 

 

 

The date upon which the balance was based. Default to system date if not used.  

openingBalance

decimal

FinancialAccountMultiCurrencyHistory Opening Balance

 

X

 

 

 

FinancialAccountMultiCurrencyHistory opening balance. In FinancialAccountMultiCurrencyHistory currency. For summary feeds only. This is the opening balance for the financial period concerned. 

openingBalanceOperatingCompanyCurrency

decimal

FinancialAccountMultiCurrencyHistory Opening Balance (Operating Company Currency)

 

X

 

 

 

FinancialAccountMultiCurrencyHistory opening balance. In operating company (base/home) currency. For summary feeds only. This is the opening balance for the financial period concerned. 

debitPostingAmount

decimal

FinancialAccountMultiCurrencyHistory Debit Posting Amount

 

X

 

 

 

FinancialAccountMultiCurrencyHistory Debit posting amount. In FinancialAccountMultiCurrencyHistory currency. For summary feeds only. This is the debit amount posted to the account for the financial period concerned. 

debitPostingAmountOperatingCompanyCurrency

decimal

FinancialAccountMultiCurrencyHistory Debit Posting Amount (Operating Company Currency)

 

X

 

 

 

FinancialAccountMultiCurrencyHistory debit posting amount. In Operating Company (base/home) currency. For summary feeds only. This is the debit amount posted to the account for the financial period concerned. 

creditPostingAmount

decimal

FinancialAccountMultiCurrencyHistory Credit Posting Amount

 

X

 

 

 

FinancialAccountMultiCurrencyHistory Credit posting amount. In FinancialAccountMultiCurrencyHistory currency. For summary feeds only. This is the credit amount posted to the account for the financial period concerned. 

creditPostingAmountOperatingCompanyCurrency

decimal

FinancialAccountMultiCurrencyHistory Credit Posting Amount (Operating Company Currency)

 

X

 

 

 

FinancialAccountMultiCurrencyHistory Credit posting amount. In Operating Company (base/home) currency. For summary feeds only. This is the credit amount posted to the account for the financial period concerned. 

lastTransactionDate

date

FinancialAccountMultiCurrencyHistory Last Transaction Date

 

X

 

 

 

Date the last transaction was posted to the FinancialAccountMultiCurrencyHistory account.  

primacyIndicator

boolean

FinancialAccountMultiCurrencyHistory Primacy Indicator

 

 

 

 

 

Flag to indicate if this FinancialAccountMultiCurrencyHistory is the primary (current) one.  

Top  

Resource financialAccountBudget

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

financialAccount

financialAccount

FinancialAccountBudget Financial Account

 

X

 

 

reference 

Link to the Financial Account associated with this financialAccountBudget. See Financial Account definition.  

financialPeriods

financialPeriod*

FinancialAccountBudget Financial Periods

 

X

 

 

association 

Link to the Financial Period(s) associated with this Financial Account Budget. A combination of Financial Account and Financial Period allows all financial budgets to be reported.  

active

boolean

FinancialAccountBudget Active Flag

 

 

 

 

 

Flag to indicate if the financialAccountBudget is an active one. Default = True  

reference

normalizedString

FinancialAccountBudget Reference

X

 

 

 

 

Reference associated with the financialAccountBudget. 

reference2

normalizedString

FinancialAccountBudget Reference2

 

X

 

 

 

Another reference associated with the financialAccountBudget.  

name

normalizedString

FinancialAccountBudget Name

 

 

 

 

 

The name of the FinancialAccountHistory (e.g. Q1 2010 REV1, Q2 2010 FINAL, etc).  

description

string

FinancialAccountBudget Description

 

X

 

 

 

A longer textual description of the financialAccountBudget.  

financialAccountBudgetType

financialAccountBudgetType

FinancialAccountBudget Type

 

X

 

 

reference 

Financial Account Budget Type. 

currency

normalizedString

FinancialAccountBudget Currency

 

 

 

 

 

The financialAccountBudget currency (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

FinancialAccountBudget OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base or home currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

FinancialAccountBudget OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from financialBudget currency into financialBudget OperatingCompanyCurrency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

FinancialAccountBudget OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from FinancialAccountBudget Currency to FinancialAccountBudget OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is amounts in FinancialAccountBudget Currency / FinancialAccountBudget OperatingCompanyCurrencyExchange Rate = amounts in FinancialAccountBudget OperatingCompanyCurrency.  

operatingCompanyCurrencyExchangeRateDate

date

FinancialAccountBudget OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from FinancialAccountBudget Currency to FinancialAccountBudget OperatingCompanyCurrency, if different. Default = System date  

balance

decimal

FinancialAccountBudget Balance

 

X

 

 

 

The financial account budget balance in the financial account budget currency.  

balanceOperatingCompanyCurrency

decimal

FinancialAccountBudget Balance (Operating Company Currency)

 

X

 

 

 

The financial account budget balance in the operating company (base/home) currency.  

date

date

FinancialAccountBudget Date

 

X

 

 

 

The date of the budget. Default to system date if not used.  

lastRevisionDate

date

FinancialAccountBudget Last revision Date

 

X

 

 

 

The date the budget was last revised. Can be left blank if not revised.  

status

financialBudgetStatus

FinancialAccountBudget Status

 

X

 

 

 

Status of the financial budget (Active, hold or closed). 

primacyIndicator

boolean

FinancialAccountBudget Primacy Indicator

 

 

 

 

 

Flag to indicate if this financialAccountBudget is the primary (current) budget in cases where there are multiple.  

statBalance

decimal

FinancialAccountBudget Statistical Balance

 

X

 

 

 

The financial account budget stat balance in the financial account stat unit.  

notes

note*

FinancialAccountBudget Note

 

X

 

 

child 

Note associated with the financialAccountBudget. See Note definition.  

Top  

Resource financialPeriod

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Financial Period Active Flag

 

 

 

 

 

Flag to indicate if the Financial Period is an active one. Default = True  

reference

normalizedString

Financial Period Reference

X

 

 

 

 

Reference for the Financial Period. 

name

normalizedString

Financial Period Name

 

 

 

 

 

Financial Period Name (e.g. Q1-Week1-2008) 

year

normalizedString

Financial Period Year

 

 

 

 

 

Financial Period Year (e.g. 2008) 

financialPeriodNumber

decimal

Financial Period Number

 

X

 

 

 

Financial Period Number expressed as a number. May be different to Month Number which may run 1-12 whereas there may be 13 periods in a year.  

financialPeriodText

normalizedString

Financial Period Number Text

 

X

 

 

 

Financial Period Number expressed as text (e.g. 01)  

quarterNumber

decimal

Financial Period Quarter Number

 

X

 

 

 

Financial Period Quarter expressed as a number (e.g. 3)  

quarterText

normalizedString

Financial Period Quarter Text

 

X

 

 

 

Financial Period Quarter expressed as text (e.g. Q3)  

monthNumber

decimal

Financial Period Month Number

 

X

 

 

 

Financial Period Month expressed as a number (e.g. 1 to 12, or 1 - 13).  

monthText

normalizedString

Financial Period Month Text

 

X

 

 

 

Financial Period Month expressed as text (e.g. January or Period 1).  

weekNumber

decimal

Financial Period Week Number

 

X

 

 

 

Financial Period week expressed as a number (e.g. 26).  

weekText

normalizedString

Financial Period Week Text

 

X

 

 

 

Financial Period week expressed as text (e.g. Week 26).  

startDate

date

Financial Period Start Date

 

X

 

 

 

Start date of the Financial Period entry (e.g. if Year is 2008 and Quarter is Q1 and Month is January then this would be 01/01/2008)  

endDate

date

Financial Period End Date

 

X

 

 

 

End date of the Financial Period entry (e.g. if Year is 2008 and Quarter is Q1 and Month is January then this would be 31/01/2008)  

status

financialPeriodStatus

Financial Period Status

 

X

 

 

 

Status of the financial period (open or closed). 

notes

note*

Financial Period Note

 

X

 

 

child 

Notes associated with a Financial Period. 

type

financialPeriodType

Financial Period Type

 

X

 

 

 

Flag to indicate the type of financial period this entry relates to. Allowable values are: Year - this entry corresponds to a full year (e.g. 2008) Quarter - this entry corresponds to a quarter within a year (e.g. Q1) Period - this entry corresponds to a period within a year (e.g. 12) Month - this entry corresonds to a month within a year (e.g. Jan) Week - this entry corresponds to a week within a period/year (e.g. 52) Day - this entry corresponds to an exact date within a week/period/year (e.g. 31/12/2008) User Defined - this entry corrsponds to a user defined value, such as a date range that spans the normal calendar 

Top  

Resource financialAccountBudgetType

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Financial Account Budget Type Active Flag

 

 

 

 

 

Flag to indicate if the Financial Account Budget Type is an active one. Default = True  

reference

normalizedString

Financial Account Budget Type Reference

X

 

 

 

 

Reference associated with the Financial Account Budget Type. 

name

normalizedString

Financial Account Budget Type Name

 

 

 

 

 

The name of the Financial Account Budget Type  

description

string

Financial Account Budget Type Description

 

X

 

 

 

A longer textual description of Financial Account Budget Type.  

notes

note*

Financial Account Budget Type Note

 

X

 

 

child 

Note associated with the Financial Account Budget Type. See Note definition.  

Top  

Resource tradingAccount

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

TradingAccount Active Flag

 

 

 

 

 

Flag to indicate if the Trading Account is an active account. Default = True  

customerSupplierFlag

supplierFlag

TradingAccount Customer Supplier Flag

 

 

 

 

 

A flag to indicate if the Trading Account is a Customer or Supplier. This can be derived from the entity linked to this Trading Account (either Customer or Supplier).  

companyPersonFlag

tradingAccountPersonFlag

TradingAccount Company Person Flag

 

 

 

 

 

A flag to indicate if the Trading Account is representative of a Company or a Person.  

invoiceTradingAccount

tradingAccount

TradingAccount Invoice TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be invoiced for transactions (e.g. Sales Orders, Purchase Orders) if different from this TradingAccount. See TradingAccount definition.  

openedDate

date

TradingAccount Opened Date

 

 

 

 

 

Date the Trading Account was opened. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

reference

normalizedString

TradingAccount Reference

X

 

 

 

 

Reference for the Trading Account. A lot of applications have a user-entered reference for resources. E.g. in Sage 200 (UK) a customer will have a database ID (1234567890) as well as a user entered reference (ABB001). The reference field is used to hold the user-entered reference (ABB001) and the id (now applicationID) would hold the database ID. In some larger ERP's (Sage 1000 for example) there may be two user entered reference fields (e.g. ABB001 and ABBEY_KITCHENS). Reference 2 is provided for this case. In some applications the user-entered value (reference) may also be used as the database ID - in which case the same value would be used in reference and applicationID.  

reference2

normalizedString

TradingAccount Reference2

 

X

 

 

 

Additional reference for the Trading Account. A lot of applications have a user-entered reference for resources. E.g. in Sage 200 (UK) a customer will have a database ID (1234567890) as well as a user entered reference (ABB001). The reference field is used to hold the user-entered reference (ABB001) and the id (now applicationID) would hold the database ID. In some larger ERP's (Sage 1000 for example) there may be two user entered reference fields (e.g. ABB001 and ABBEY_KITCHENS). Reference 2 is provided for this case. In some applications the user-entered value (reference) may also be used as the database ID - in which case the same value would be used in reference and applicationID.  

status

normalizedString

TradingAccount Status

 

X

 

 

 

Status of the Trading Account. 

name

normalizedString

TradingAccount Name

 

 

 

X

 

The Trading Account name. 

shortName

normalizedString

TradingAccount Short Name

 

X

 

 

 

A shorter name for the Trading Account. 

type

tradingAccountType

TradingAccount Type

 

X

 

 

 

The Trading Account type. Default = Unknown 

registeredAddress

postalAddress

TradingAccount Registered Address

 

X

 

 

reference 

Link to the Trading Account registered address (e.g. main/office address). See PostalAddress definition.  

postalAddresses

postalAddress*

TradingAccount PostalAddress

 

X

 

 

child 

Link to the Trading Account address(es) (e.g. invoice/billing address). See PostalAddress definition.  

shippingAddresses

postalAddress*

TradingAccount ShippingAddress

 

X

 

 

association 

Link to the Trading Account shipping address. See PostalAddress definition.  

billingAddresses

postalAddress*

TradingAccount BillingAddress

 

X

 

 

association 

Link to the Trading Account billing address. See PostalAddress definition.  

phones

phoneNumber*

TradingAccount Phone

 

X

 

 

child 

Trading account telephone number(s). See PhoneNumber definition.  

emails

email*

TradingAccount Email

 

X

 

 

child 

Trading account email address(es). See Email definition.  

website

normalizedString

TradingAccount Web Site

 

X

 

 

 

Trading Account web site address. 

contacts

contact*

TradingAccount Contact

 

X

 

 

association 

Link to the accounting Contact(s) for this tradingAccount. See Contact definition.  

deliveryContact

contact

TradingAccount Delivery Contact

 

X

 

 

reference 

Link to the Contact for deliveries to this Trading Account. Default = Primary Contact  

salesPersons

salesPerson*

TradingAccount SalesPersons

 

X

 

 

association 

Sales person(s) associated with the Trading Account. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people. Could default from Customer (or Supplier).  

deliveryMethod

normalizedString

TradingAccount Delivery Method

 

X

 

 

 

Preferred Delivery method to be used for the Trading Account (e.g. Courier, Collection, etc). Could default from Customer (or Supplier).  

deliveryRule

boolean

TradingAccount Delivery Rule

 

X

 

 

 

Does the Trading Account accept full or partial deliveries. True = Accepts partial deliveries; False = Does not accept partial deliveries. Default = True Could default from Customer (or Supplier).  

currency

normalizedString

TradingAccount Currency

 

 

 

 

 

The Trading Account currency (e.g. GBP, USD, EUR). ISO 4217.  

taxCodes

taxCode*

TradingAccount Tax Codes

 

X

 

 

association 

Tax code governing the tax regime applicable to this Trading Account. See TaxCode definition.  

taxReference

normalizedString

TradingAccount Tax Reference

 

X

 

 

 

Tax reference associated with the Trading Account.  

taxationCountry

normalizedString

TradingAccount Taxation Country

 

X

 

 

 

The country whose tax regime applies to this Trading Account. ISO 3166-1 alpha-2 country codes only. Could default from PostalAddress.  

useTaxInclusivePrices

boolean

TradingAccount Use Tax Inclusive Prices

 

X

 

 

 

Flag to indicate if prices associated with this Trading Account are inclusive of tax, or not. Default = No (prices are not inclusive of tax)  

financeBalance

decimal

TradingAccount Finance Balance

 

X

 

 

 

Trading account financial balance. In TradingAccount currency.  

financeLimit

decimal

TradingAccount Finance Limit

 

X

 

 

 

Trading account financial (credit) limit. In TradingAccount currency.  

financeBalanceDate

date

TradingAccount Finance Balance Date

 

X

 

 

 

The date upon which the finance balance was based. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats Default = System date  

financeStatusFlag

boolean

TradingAccount Finance Status Flag

 

X

 

 

 

Trading account financial status (e.g. on hold (or blocked), off hold). True is on hold, False is not on hold. Default = False  

financeStatusText

normalizedString

TradingAccount Finance Status Text

 

X

 

 

 

Trading account financial status text. Please note: this is the label used to describe the Finance Status Flag above - it is not a status in its own right. Default = On Hold  

settlementDiscountType

discountType

TradingAccount Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to the Trading Account (percent or amount). Default = Percent  

settlementDiscountAmount

decimal

TradingAccount Settlement Discount Amount

 

X

 

 

 

Settlement discount applicable to the Trading Account expressed as an amount.  

settlementDiscountPercent

decimal

TradingAccount Settlement Discount Percent

 

X

 

 

 

Settlement discount applicable to the Trading Account expressed as a percent.  

settlementDiscountTerms

normalizedString

TradingAccount Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days.  

settlementDiscountTermsCommencement

normalizedString

TradingAccount Settlement Discount Terms Commencement

 

X

 

 

 

For some types of settlement discount it is necessary to know when the terms start, e.g. if terms are 30 days from end of month.  

settlementDiscountIncludedInTotal

boolean

TradingAccount Settlement Discount Included In Total

 

X

 

 

 

Flag to indicate if settlement discount is included in document totals (e.g. Invoices, etc). Default = False  

paymentTerms

normalizedString

TradingAccount Payment Terms

 

X

 

 

 

Period in which outstanding amounts must be paid (e.g. 30 days, by end of month EOM). Also after this period additional (sur)charges may apply.  

paymentTermsCommencement

normalizedString

TradingAccount Payment Terms Commencement

 

X

 

 

 

For some types of payment terms it is necessary to know when the terms start, e.g. if terms are 30 days from end of month.  

orderDiscountType

discountType

TradingAccount Order Discount Type

 

X

 

 

 

Flag to indicate the type of order discount applicable to the Trading Account (percent or amount). Percent Amount Both Default = Percent  

orderDiscountAmount

decimal

TradingAccount Order Discount Amount

 

X

 

 

 

Any discount that may be applicable to orders (or quotations) raised against the account, expressed as an amount.  

orderDiscountPercent

decimal

TradingAccount Order Discount Percent

 

X

 

 

 

Any discount that may be applicable to orders (or quotations) raised against the account, expressed as a percent.  

orderText1

string

TradingAccount Order Text1

 

X

 

 

 

Text to be shown by default on orders raised against this Trading Account. Header text.  

orderText2

string

TradingAccount Order Text2

 

X

 

 

 

Text to be shown by default on orders raised against this Trading Account. Footer text.  

orderLineDiscountType

discountType

TradingAccount Order Line Discount Type

 

X

 

 

 

Flag to indicate the type of order Line discount applicable to the Trading Account (percent or amount). Percent Amount Both Default = Percent  

orderLineDiscountAmount

decimal

TradingAccount Order Line Discount Amount

 

X

 

 

 

Any discount that may be applicable to order (or quotation) lines raised against the account, expressed as an amount.  

orderLineDiscountPercent

decimal

TradingAccount Order Line Discount Percent

 

X

 

 

 

Any discount that may be applicable to order (or quotation) lines raised against the account, expressed as a percent.  

orderLineText1

string

TradingAccount OrderLine Text1

 

X

 

 

 

Text to be shown by default on order lines raised against this Trading Account.  

orderLineText2

string

TradingAccount OrderLine Text2

 

X

 

 

 

Text to be shown by default on order lines raised against this Trading Account.  

invoiceDiscountType

discountType

TradingAccount Invoice Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to invoices raised against the Trading Account (percent or amount). Percent Amount Both Default = Percent  

invoiceDiscountAmount

decimal

TradingAccount Invoice Discount Amount

 

X

 

 

 

Any discount that may be applicable to invoices raised against the Trading Account, expressed as an amount.  

invoiceDiscountPercent

decimal

TradingAccount Invoice Discount Percent

 

X

 

 

 

Any discount that may be applicable to invoices raised against the Trading Account, expressed as a percentage.  

invoiceText1

string

TradingAccount Invoice Text1

 

X

 

 

 

Text to be shown by default on Invoice raised against this Trading Account. Header text  

invoiceText2

string

TradingAccount Invoice Text2

 

X

 

 

 

Text to be shown by default on Invoice raised against this Trading Account. Footer text  

bankAccounts

bankAccount*

TradingAccount BankAccount

 

X

 

 

association 

Bank account associated with the Trading Account, e.g. for electronic Payment, direct debits, bank transfers, etc. See BankAccount definition.  

tenderType

normalizedString

TradingAccount Default Tender Type

 

X

 

 

 

Tender Type used by Trading Account (e.g. if this Trading Account is associated with a Customer then this is the tender type used on Receipts/Payments associated with the Customer, e.g. BACS, check, Cash, Commercial Papers, etc).  

defaultFulfillmentLocation

location

TradingAccount Default Fulfillment Location

 

X

 

 

reference 

The default Location to be used for fulfillment (e.g. the warehouse to take deliveries of purchase orders or from which to deliver sales orders). See Location definition. Could default from Customer (or Supplier).  

pricelists

priceList*

TradingAccount PriceList

 

X

 

 

association 

Price list associated with the Trading Account. See PriceList definition.  

pricingOverride

priceList

TradingAccount Pricing Override

 

X

 

 

reference 

Pricing override applicable with the Trading Account (e.g. for discounting). See PriceList definition.  

accountingType

tradingAccountAccountingType

TradingAccount Accounting Type

 

X

 

 

 

Accounting type applicable to the Trading Account (e.g. cash, open item, balance forward, etc). Default = Unknown  

financialAccounts

financialAccount*

TradingAccount FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Trading Account (typically the revenue account). See FinancialAccount definition.  

costCentres

costCentre*

TradingAccount CostCentre

 

X

 

 

association 

Cost Centre(s) associated with this Trading Account. See Cost Centre definition.  

departments

department*

TradingAccount Departments

 

X

 

 

association 

Department(s) associated with this Trading Account. See Department definition.  

primacyIndicator

boolean

TradingAccount Primacy Indicator

 

X

 

 

 

Flag to indicate if this is the primary Trading Account associated with a Customer (or Supplier). Only 1 Trading Account can be the primary for an associated Customer (or Supplier).  

opportunities

opportunity*

TradingAccount Opportunity

 

X

 

 

association 

Opportunities associated with the Trading Account. See Opportunity definition.  

salesQuotations

salesQuotation*

TradingAccount Sales Quotation

 

X

 

 

association 

Sales Quotation(s) associated with the Trading Account. See SalesQuotation definition.  

salesOrders

salesOrder*

TradingAccount Sales Order

 

X

 

 

association 

Sales Order(s) associated with the Trading Account. See SalesOrder definition.  

salesOrderDeliveries

salesOrderDelivery*

TradingAccount Sales Order Delivery

 

X

 

 

association 

Sales Order Delivery(s) associated with the Trading Account. See SalesOrderDelivery definition.  

salesInvoices

salesInvoice*

TradingAccount Sales Invoice

 

X

 

 

association 

Sales Invoice(s) associated with the Trading Account. See SalesInvoice definition.  

salesReturns

salesReturn*

TradingAccount Sales Return

 

X

 

 

association 

Sales Return(s) associated with the Trading Account. See SalesReturn definition.  

salesReturnDeliveries

salesReturnDelivery*

TradingAccount Sales Return Delivery

 

X

 

 

association 

Sales Return Delivery(s) associated with the Trading Account. See SalesReturnDelivery definition.  

salesCredits

salesCredit*

TradingAccount Sales Credit

 

X

 

 

association 

Sales Credit(s) associated with the Trading Account. See SalesCredit definition.  

purchaseRequisitions

purchaseRequisition*

TradingAccount Purchase Requisition

 

X

 

 

association 

Purchase Requisition(s) associated with the Trading Account. See PurchaseRequisition definition.  

purchaseOrders

purchaseOrder*

TradingAccount Purchase Order

 

X

 

 

association 

Purchase Order(s) associated with the Trading Account. See PurchaseOrder definition.  

purchaseOrderDeliveries

purchaseOrderDelivery*

TradingAccount Purchase Order Delivery

 

X

 

 

association 

Purchase Order Delivery(s) associated with the Trading Account. See PurchaseOrderDelivery definition.  

purchaseInvoices

purchaseInvoice*

TradingAccount Purchase Invoice

 

X

 

 

association 

Purchase Invoice(s) associated with the Trading Account. See PurchaseInvoice definition.  

purchaseReturns

purchaseReturn*

TradingAccount Purchase Return

 

X

 

 

association 

Purchase Return(s) associated with the Trading Account. See PurchaseReturn definition.  

purchaseReturnDeliveries

purchaseReturnDelivery*

TradingAccount Purchase Return Delivery

 

X

 

 

association 

Purchase Return Delivery(s) associated with the Trading Account. See PurchaseReturnDelivery definition.  

purchaseCredits

purchaseCredit*

TradingAccount Purchase Credit

 

X

 

 

association 

Purchase Credit(s) associated with the Trading Account. See PurchaseCredit definition.  

receipts

receipt*

TradingAccount Receipt

 

X

 

 

association 

Receipt(s) associated with the Trading Account. See Receipt definition.  

payments

payment*

TradingAccount Payment

 

X

 

 

association 

Payment(s) associated with the Trading Account. See Payment definition.  

interactions

interaction*

TradingAccount Interactions

 

X

 

 

association 

Interaction(s) associated with the Trading Account. See Interaction definition.  

projects

project*

TradingAccount Project

 

X

 

 

association 

Project(s) associated with the TradingAccount. See Project definition.  

cases

case*

TradingAccount Cases

 

X

 

 

association 

Case(s) associated with the Trading Account. See Case definition.  

notes

note*

TradingAccount Note

 

X

 

 

child 

Notes associated with a Trading Account (e.g. credit control).  

Top  

Resource contact

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

contactGroups

contactGroup*

Contact ContactGroup

 

X

 

 

association 

A link to the Contact Group associated with this Contact. See ContactGroup definition. Contacts can belong to multiple Contact Groups.  

active

boolean

Contact Active Flag

 

 

 

 

 

Flag to indicate if the Contact is an active Contact. Default = True  

reference

normalizedString

Contact Reference

X

 

 

 

 

Reference for the Contact. 

reference2

normalizedString

Contact Reference2

 

X

 

 

 

Additional reference for the Contact. 

status

normalizedString

Contact Status

 

X

 

 

 

Status of the Contact. 

type

normalizedString

Contact Type

 

X

 

 

 

The Contact type. 

gender

contactGender

Contact Gender

 

X

 

 

 

The gender of the Contact (e.g. Male, Female, Not Specified).  

fullName

normalizedString

Contact Full Name

 

 

 

X

 

The full name of the Contact, e.g. title, first name, family name, suitably spaced. Formatted name for display purposes.  

salutation

normalizedString

Contact Salutation

 

X

 

 

 

The salutation to be used when addressing the Contact (Dear, Your Excellency, etc).  

firstName

normalizedString

Contact First Name

 

X

 

 

 

The first name of the Contact. 

preferredName

normalizedString

Contact Preferred Name

 

X

 

 

 

The name preferred by the Contact - may be first name or a nick name. Could use First Name as default  

familyName

normalizedString

Contact Family Name

 

X

 

 

 

The family name (surname) of the Contact. 

title

normalizedString

Contact Title

 

X

 

 

 

The title of the Contact. Language-specific 

middleName

normalizedString

Contact Middle Name

 

X

 

 

 

The middle name of the Contact. 

suffix

normalizedString

Contact Suffix

 

X

 

 

 

A name suffix associated with the Contact (e.g. PhD, OBE, etc)  

financialAccounts

financialAccount*

Contact FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Contact (typically the revenue account). See FinancialAccount definition.  

costCentres

costCentre*

Contact CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Contact. See Cost Centre definition.  

departments

department*

Contact Departments

 

X

 

 

association 

Department(s) associated with this Contact. See Department definition.  

age

decimal

Contact Age

 

X

 

 

 

The age of the Contact. Could be calculated from date of birth.  

dateOfBirth

date

Contact Date Of Birth

 

X

 

 

 

The date of birth of the Contact. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

nationality

normalizedString

Contact Nationality

 

X

 

 

 

The nationality of the Contact. 

language

normalizedString

Contact Language

 

X

 

 

 

Language used (spoken) by the Contact in ISO 639-1 format e.g. en for English, fr for French, de for German, etc.  

maritalStatus

normalizedString

Contact Marital Status

 

X

 

 

 

The marital status (single, married, etc) of the Contact.  

countryOfResidence

normalizedString

Contact Country of Residence

 

X

 

 

 

The country of residence of the Contact. ISO 3166-1 alpha-2 country codes only  

nationalInsuranceNumber

normalizedString

Contact National Insurance Number

 

X

 

 

 

The national insurance, or country-specific equivalent, number.  

taxReference

normalizedString

Contact Tax Reference

X

X

 

 

 

Reference number for tax purposes of the Contact (e.g. UK UTR).  

postalAddresses

postalAddress*

Contact PostalAddress

 

X

 

 

child 

Link to the Contact address(es) (e.g. office, home). See PostalAddress definition.  

phones

phoneNumber*

Contact Phone

 

X

 

 

child 

Contact telephone number(s). See PhoneNumber definition.  

emails

email*

Contact Email

 

X

 

 

child 

Contact email address(es). See Email definition.  

website

normalizedString

Contact Web Site

 

X

 

 

 

Contact web site address. 

tradingAccount

tradingAccount

Contact TradingAccount

 

X

 

 

reference 

Link to the Trading Account (if any) associated with this Contact. See TradingAccount definition.  

bankAccounts

bankAccount*

Contact Bank Account

 

X

 

 

association 

Link to the Bank Account (if any) associated with this Contact. See BankAccount definition.  

location

location

Contact Location

 

X

 

 

reference 

Link to the Location (if any) associated with this Contact. See Location definition.  

jobTitle

normalizedString

Contact Job Title

 

X

 

 

 

The job title of the Contact. 

companyContext

contactCompanyContext

Contact Company Context

 

X

 

 

 

The description of the Contact's reference with a Company (if any) e.g. Employee, Subcontractor, etc. Default = Unknown  

user

normalizedString

Contact User

 

X

 

 

 

Default system user associated with this Contact, e.g. the Contact manager. The user resource will be defined in the future.  

employee

person

Contact Employee

 

X

 

 

reference 

A link to the Employee associated with this Contact. See Employee definition. Employees are defined in the HRM-ERP Schema.  

primacyIndicator

boolean

Contact Primacy Indicator

 

 

 

 

 

A flag to indicate if the Contact is the primary/default Contact. Only one Contact can have primacy against an associated Company. Default = False  

opportunities

opportunity*

Contact Opportunity

 

X

 

 

association 

Opportunities associated with the Contact. See Opportunity definition.  

salesQuotations

salesQuotation*

Contact Sales Quotation

 

X

 

 

association 

Sales Quotation(s) associated with the Contact. See SalesQuotation definition.  

salesOrders

salesOrder*

Contact Sales Order

 

X

 

 

association 

Sales Order(s) associated with the Contact. See SalesOrder definition.  

salesOrderDeliveries

salesOrderDelivery*

Contact Sales Order Delivery

 

X

 

 

association 

Sales Order Delivery(s) associated with the Contact. See SalesOrderDelivery definition.  

salesInvoices

salesInvoice*

Contact Sales Invoice

 

X

 

 

association 

Sales Invoice(s) associated with the Contact. See SalesInvoice definition.  

salesReturns

salesReturn*

Contact Sales Return

 

X

 

 

association 

Sales Return(s) associated with the Contact. See SalesReturn definition.  

salesReturnDeliveries

salesReturnDelivery*

Contact Sales Return Delivery

 

X

 

 

association 

Sales Return Delivery(s) associated with the Contact. See SalesReturnDelivery definition.  

salesCredits

salesCredit*

Contact Sales Credit

 

X

 

 

association 

Sales Credit(s) associated with the Contact. See SalesCredit definition.  

purchaseRequisitions

purchaseRequisition*

Contact Purchase Requisition

 

X

 

 

association 

Purchase Requisition(s) associated with the Contact. See PurchaseRequisition definition.  

purchaseOrders

purchaseOrder*

Contact Purchase Order

 

X

 

 

association 

Purchase Order(s) associated with the Contact. See PurchaseOrder definition.  

purchaseOrderDeliveries

purchaseOrderDelivery*

Contact Purchase Order Delivery

 

X

 

 

association 

Purchase Order Delivery(s) associated with the Contact. See PurchaseOrderDelivery definition.  

purchaseInvoices

purchaseInvoice*

Contact Purchase Invoice

 

X

 

 

association 

Purchase Invoice(s) associated with the Contact. See PurchaseInvoice definition.  

purchaseReturns

purchaseReturn*

Contact Purchase Return

 

X

 

 

association 

Purchase Return(s) associated with the Contact. See PurchaseReturn definition.  

purchaseReturnDeliveries

purchaseReturnDelivery*

Contact Purchase Return Delivery

 

X

 

 

association 

Purchase Return Delivery(s) associated with the Contact. See PurchaseReturnDelivery definition.  

purchaseCredits

purchaseCredit*

Contact Purchase Credit

 

X

 

 

association 

Purchase Credit(s) associated with the Contact. See PurchaseCredit definition.  

interactions

interaction*

Contact Interactions

 

X

 

 

association 

Interaction(s) associated with the Contact. See Interaction definition.  

projects

project*

Contact Project

 

X

 

 

association 

Project(s) associated with the Contact. See Project definition.  

cases

case*

Contact Cases

 

X

 

 

association 

Case(s) associated with the Contact. See Case definition.  

notes

note*

Contact Note

 

X

 

 

child 

Notes associated with a Contact. 

Top  

Resource contactGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

ContactGroup Active Flag

 

 

 

 

 

Flag to indicate if the Contact Group is an active one. Default = True  

name

normalizedString

ContactGroup Name

 

 

 

X

 

Name of the Contact Group. If this does not exist then a dummy entry should be created, e.g. MAS500 Customer Contacts  

reference

normalizedString

ContactGroup Reference

X

 

 

 

 

Reference for the Contact Group. 

description

normalizedString

ContactGroup Description

 

X

 

 

 

A longer description of the Contact Group. 

associatedContactGroups

contactGroup*

ContactGroup Associated ContactGroups

 

X

 

 

association 

A link to other Contact Group(s) associated with this one.  

contacts

contact*

ContactGroup Contact

 

X

 

 

association 

Contacts associated with the Contact Group. See Contact definition. Contacts can belong to multiple Contact Groups.  

notes

note*

ContactGroup Note

 

X

 

 

child 

Notes associated with a Contact Group. 

Top  

Resource salesOrder

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesOrder Active Flag

 

 

 

 

 

Flag to indicate if the Sales Order is an active one. Default = True  

reference

normalizedString

SalesOrder Reference

X

 

 

 

 

Reference for the Sales Order. 

reference2

normalizedString

SalesOrder Reference2

 

X

 

 

 

Additional reference for the Sales Order. 

status

salesOrderStatus

SalesOrder Status

 

X

 

 

 

Status of the Sales Order 

allocationStatus

salesOrderAllocationStatus

SalesOrder Allocation Status

 

X

 

 

 

Status of Commodity allocations against the order.  

deliveryStatus

salesOrderDeliveryStatus

SalesOrder Delivery Status

 

X

 

 

 

Delivery status of the order. 

invoiceStatus

salesOrderInvoiceStatus

SalesOrder Invoice Status

 

X

 

 

 

Invoice status of the order. 

statusFlag

boolean

SalesOrder Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. order on hold (or blocked), off hold). True is on hold, False is not on hold. Default value is False.  

statusFlagText

normalizedString

SalesOrder Status Flag Text

 

X

 

 

 

Sales Order status flag text. Default = On Hold 

tradingAccount

tradingAccount

SalesOrder Customer TradingAccount

 

 

 

 

reference 

Link to the Sales Order Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesOrder Customer Reference

 

X

 

 

 

Customer own reference for the Sales Order (e.g. a PO number).  

opportunity

opportunity

SalesOrder Opportunity

 

X

 

 

reference 

Opportunity linked to the Sales Order (if any). See Opportunity definition.  

pricelist

priceList

SalesOrder PriceList

 

X

 

 

reference 

Link to the Price List used when generating the Sales Order. See PriceList definition.  

supplierTradingAccount

tradingAccount

SalesOrder Supplier TradingAccount

 

X

 

 

reference 

Link to the Sales Order Supplier account (e.g. for back to back, contremarque, drop-ship ordering). See TradingAccount definition. These are also stored on SalesOrderLines  

supplierReference

normalizedString

SalesOrder Supplier Reference

 

X

 

 

 

Supplier own reference for the Sales Order. 

supplierPurchaseOrders

purchaseOrder*

SalesOrder Supplier PurchaseOrder

 

X

 

 

association 

Link to any Supplier Purchase Orders used to fulfill the Sales Order (back to back or drop-ship). See PurchaseOrder definition. These are also stored on SalesOrderLines  

type

normalizedString

SalesOrder Type

 

X

 

 

 

The Sales Order type. 

copyFlag

boolean

SalesOrder Copy Flag

 

 

 

 

 

Indicates if this Sales Order is a copy or not. Default is false (no)  

originatorDocument

salesOrderOriginatorDocument--choice

SalesOrder Originator Document Reference

 

X

 

 

reference 

Reference to another Sales Order if required (e.g. if order is a copy, then this will show which order was copied, If this is a replacement order this will show the original order).  

quotation

salesQuotation

SalesOrder Quotation

 

X

 

 

reference 

A link to the quotation used to create this Sales Order (if any). See Quotation definition. Must be a valid quotation.  

postalAddresses

postalAddress*

SalesOrder PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Order. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc. These are also stored on SalesOrderLines  

deliveryMethod

normalizedString

SalesOrder Delivery Method

 

X

 

 

 

Delivery method to be employed for Sales Order (e.g. Courier, Collection, etc)  

deliveryRule

boolean

SalesOrder Delivery Rule

 

X

 

 

 

Flag to indicate if the order has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryTerms

normalizedString

SalesOrder Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

SalesOrder Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dueDate

date

SalesOrder Due Date

 

X

 

 

 

Date the order is due by the Customer. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats. Delivery date may be different to the Customer due date.  

carrierCompany

normalizedString

SalesOrder Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Sales Order. See Company definition. Carriers are not used by all application.  

carrierTradingAccounts

tradingAccount*

SalesOrder Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Order. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesOrder Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Order currency.  

carrierTaxPrice

decimal

SalesOrder Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Order currency. 

carrierTotalPrice

decimal

SalesOrder Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + tax). In Order currency.  

carrierSalesInvoices

salesInvoice*

SalesOrder Carrier SalesInvoices

 

X

 

 

association 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoices

purchaseInvoice*

SalesOrder Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesOrder Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Order. See TaxCode definition.  

carrierReference

normalizedString

SalesOrder Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

SalesOrder Currency

 

 

 

 

 

The currency of the Sales Order (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

SalesOrder OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesOrder OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Order Currency into Sales Order OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesOrder OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Order Currency to Sales Order OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Operating Company Currency Exchange Rate = Sales Order Values in Sales Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesOrder OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Order Currency to Sales Order OperatingCompany Currency, if different. Default = System date  

invoiceCurrency

normalizedString

SalesOrder Invoice Currency

 

X

 

 

 

The currency to be used on invoices associated with this order. ISO 4217. Could be derived from order currency.  

invoiceCurrencyExchangeRate

decimal

SalesOrder Invoice Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Order Currency into Sales Order Invoice Currency, if different.  

invoiceCurrencyExchangeRateOperator

rateOperator

SalesOrder Invoice Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Order Currency to Sales Order Invoice Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Invoice Currency Exchange Rate = Sales Order Values in Sales Order Invoice Currency.  

invoiceCurrencyExchangeRateDate

date

SalesOrder Invoice Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Order Currency to Sales Order Invoice Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesOrder Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Customer Trading Account on the Sales Order. ISO 4217. Could be derived from order currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesOrder Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Order currency into the Customer Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesOrder Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Order Currency to Sales Order Customer Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Customer TradingAccount Currency Exchange Rate = Sales Order Values in Sales Order Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesOrder Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Order Currency to Customer Trading Account Currency, if different. Default = System date  

date

date

SalesOrder Date

 

 

 

 

 

Date the Sales Order was placed. 

time

time

SalesOrder Time

 

X

 

 

 

Time the Sales Order was placed. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

validity

decimal

SalesOrder Validity

 

X

 

 

 

Period the Sales Order is valid for (days from Order Date).  

expirationDate

date

SalesOrder Expiration Date

 

X

 

 

 

The expiration date of the Sales Order (SalesOrder Date + Validity).  

taxCodes

taxCode*

SalesOrder Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Order. See TaxCode definition.  

buyerContact

contact

SalesOrder Buyer Contact

 

X

 

 

reference 

Link to the Contact at Customer who placed the Sales Order. See Contact definition. Default = Primary TradingAccount Contact  

salesPersons

salesPerson*

SalesOrder SalesPersons

 

X

 

 

association 

Sales person associated with the Sales Order. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

user

normalizedString

SalesOrder User

 

X

 

 

 

Link to the user who placed the Sales Order. The user resource will be defined in the future.  

salesOrderLines

salesOrderLine*

SalesOrder SalesOrderLine

 

 

 

 

child 

Sales order Line detail (e.g. items on the Sales Order). See SalesOrderLine definition.  

lineCount

decimal

SalesOrder Line Count

 

 

 

 

 

The number of lines on the Sales Order. Should be auto-populated. Used as a cross reference to ensure order integrity.  

orderDiscountType

discountType

SalesOrder Order Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Order (percent or amount). From the Trading Account.  

orderDiscountAmount

decimal

SalesOrder Order Discount Amount

 

X

 

 

 

Discount applicable to the Sales Order expressed as an amount. From the Trading Account.  

orderDiscountPercent

decimal

SalesOrder Order Discount Percent

 

X

 

 

 

Discount applicable to the Sales Order expressed as a percent. From the Trading Account.  

orderAdditionalDiscount1Type

discountType

SalesOrder Order Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Order (percent or amount). Percent Amount Both  

orderAdditionalDiscount1Amount

decimal

SalesOrder Order Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Sales Order expressed as an amount.  

orderAdditionalDiscount1Percent

decimal

SalesOrder Order Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Sales Order expressed as a percent.  

orderAdditionalDiscount2Type

discountType

SalesOrder Order Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Order (percent or amount)  

orderAdditionalDiscount2Amount

decimal

SalesOrder Order Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Sales Order expressed as an amount.  

orderAdditionalDiscount2Percent

decimal

SalesOrder Order Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Sales Order expressed as a percent.  

text1

string

SalesOrder Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Order. Header text.  

text2

string

SalesOrder Text2

 

X

 

 

 

Further text/commentary for the Sales Order. Footer text.  

netTotal

decimal

SalesOrder Net Total

 

 

 

 

 

Total value of the Sales Order, including discounts, excluding tax. In order currency.  

discountTotal

decimal

SalesOrder Discount Total

 

 

 

 

 

Total discounts applied to the order. In order currency  

chargesTotal

decimal

SalesOrder Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Order (e.g. finance charges, interest). In order currency.  

taxTotal

decimal

SalesOrder Tax Total

 

 

 

 

 

Total tax applicable to the Sales Order. In order currency.  

grossTotal

decimal

SalesOrder Gross Total

 

 

 

 

 

Total value of the Sales Order, including tax & discounts & charges. In order currency.  

costTotal

decimal

SalesOrder Cost Total

 

X

 

 

 

Total cost of the Sales Order. In order currency. 

profitTotal

decimal

SalesOrder Profit Total

 

X

 

 

 

Total profit on the Sales Order (e.g. net total - cost total). In order currency.  

receipts

receipt*

SalesOrder Receipt

 

X

 

 

association 

Link to the Sales Order receipt (e.g. if order is taken with payment or if a deposit has been paid). See Receipt definition.  

depositFlag

boolean

SalesOrder Deposit Flag

 

X

 

 

 

Flag to indicate if a deposit has been paid with the order. Default = False (no deposit taken).  

contract

string

SalesOrder Contract

 

X

 

 

 

Reference to a contract associated with the Sales Order. If Contracts aren't used there may be an estimate instead - this would contain the reference of the estimate.  

invoiceTradingAccount

tradingAccount

SalesOrder Invoice TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be invoiced for the Sales Order (if different from the Customer), e.g. Bill To. See TradingAccount definition.  

invoiceCountry

normalizedString

SalesOrder Invoice Country

 

X

 

 

 

Country to which the Sales Invoice is sent (e.g. for taxation purposes). ISO 3166-1 alpha-2 country codes only  

orderCountry

normalizedString

SalesOrder Order Country

 

X

 

 

 

Country of destination for the Sales Order (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only  

projects

project*

SalesOrder Project

 

X

 

 

association 

Identifier of the Project this Sales Order is for. See Project definition.  

projectLines

projectLine*

SalesOrder ProjectLine

 

X

 

 

association 

Project Line value for this Sales Order. See Project Line definition. Some applications may not have Project Lines.  

cases

case*

SalesOrder Cases

 

X

 

 

association 

The reference of the case associated with the Sales Order, e.g. if the Order is for repair/fix services. A Case entity has been defined to support the F2F process.  

salesOrderDeliveries

salesOrderDelivery*

SalesOrder SalesOrderDelivery

 

X

 

 

association 

Link to the Delivery (dispatch) against the Sales Order. If there are multiple then these are held against the Sales Order Line. See SalesOrderDelivery definition.  

fulfillmentLocations

location*

SalesOrder Fulfilment Location

 

X

 

 

association 

The Location from which the Sales Order will be fulfilled (e.g. the warehouse holding the Commodity). See Location definition. May be held at Line level instead.  

financialAccounts

financialAccount*

SalesOrder FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Order. See FinancialAccount definition. Could come from the Trading Account.  

costCentres

costCentre*

SalesOrder CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Order. See Cost Centre definition.  

departments

department*

SalesOrder Departments

 

X

 

 

association 

Department(s) associated with this Sales Order. See Department definition.  

interactions

interaction*

SalesOrder Interactions

 

X

 

 

association 

Interaction(s) associated with the Sales Order. See Interaction definition.  

notes

note*

SalesOrder Note

 

X

 

 

child 

Notes associated with a Sales Order. 

Top  

Resource salesOrderLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesOrder

salesOrder

SalesOrderLine Sales Order

 

 

 

 

parent 

The parent sales order. 

active

boolean

SalesOrderLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Order Line is an active one. Default = True  

reference

normalizedString

SalesOrderLine Reference

X

 

 

 

 

Reference for the Sales Order Line. 

reference2

normalizedString

SalesOrderLine Reference2

 

X

 

 

 

Additional reference for the Sales Order Line. 

number

decimal

SalesOrderLine Number

 

 

 

 

 

The number of the Sales Order Line. For sequencing and ordering of lines.  

status

salesOrderStatus

SalesOrderLine Status

 

X

 

 

 

Status of the Sales Order Line. 

type

lineType

SalesOrderLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Order Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

deliveryTerms

normalizedString

SalesOrderLine Delivery Terms

 

X

 

 

 

The terms for Delivery for this Sales Order Line. Also on Sales Order but may be different per Line.  

commodity

commodity

SalesOrderLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Order Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

SalesOrderLine Text

 

X

 

 

 

Text applicable to the Sales Order Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Order Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesOrderLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Sales Order Line. See Variant definition.  

commodityDimension

commodityDimension

SalesOrderLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the Sales Order Line. See Dimension definition.  

commodityIdentifier

commodityIdentifier

SalesOrderLine Commodity Identifier

 

X

 

 

reference 

Link to the Commodity Identifier(s) for this Sales Order Line, if it is traced to that level of detail.  

associatedCommodity

commodity

SalesOrderLine Associated Commodity

 

X

 

 

reference 

Link to the Commodity associated with the Sales Order Line, e.g. if Line is for service to another Commodity. See Commodity definition.  

fulfillmentLocation

location

SalesOrderLine Fulfillment Location

 

X

 

 

reference 

The Location from which the Sales Order Line will be fulfilled (e.g. the warehouse holding the Commodity). See Location definition.  

deliveryDate

date

SalesOrderLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

dueDate

date

SalesOrderLine Due Date

 

X

 

 

 

Date the Sales Order Line is due by the Customer. Delivery date may be different to the Customer due date.  

carrierTradingAccount

tradingAccount

SalesOrderLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Order Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesOrderLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Order currency.  

carrierTaxPrice

decimal

SalesOrderLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Order currency. 

carrierTotalPrice

decimal

SalesOrderLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + tax). In Order currency.  

carrierSalesInvoiceLine

salesInvoiceLine

SalesOrderLine Carrier SalesInvoiceLine

 

X

 

 

reference 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

SalesOrderLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesOrderLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Order Line. See TaxCode definition.  

carrierReference

normalizedString

SalesOrderLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

unitOfMeasure

unitOfMeasure

SalesOrderLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

SalesOrderLine Quantity

 

 

 

X

 

The quantity of the Commodity ordered on the Sales Order Line.  

initialPrice

decimal

SalesOrderLine Initial Price

 

 

 

 

 

The initial price of the Commodity ordered on the Sales Order Line (e.g. before discounts). In order currency.  

pricelist

priceList

SalesOrderLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Sales Order Line. See PriceList definition.  

supplierTradingAccount

tradingAccount

SalesOrderLine Supplier TradingAccount

 

X

 

 

reference 

Link to the Sales Order Line Supplier account (e.g. for back to back, contremarque, drop-ship ordering). See TradingAccount definition.  

supplierReference

normalizedString

SalesOrderLine Supplier Reference

 

X

 

 

 

Supplier own reference for the Sales Order Line. 

supplierPurchaseOrders

purchaseOrder*

SalesOrderLine Supplier PurchaseOrders

 

X

 

 

association 

Link to any Supplier Purchase Orders used to fulfill the Sales Order Line (back to back or drop-ship). See PurchaseOrder definition.  

supplierPurchaseOrderLines

purchaseOrderLine*

SalesOrderLine Supplier PurchaseOrderLines

 

X

 

 

association 

Link to any Supplier Purchase Order Lines used to fulfill the Sales Order Line (back to back or drop-ship). See PurchaseOrderLine definition.  

quotationLine

salesQuotationLine

SalesOrderLine QuotationLine

 

X

 

 

reference 

A link to the Quotation Line used to create this Sales Order Line (if any). See QuotationLine definition. Must be a valid quotation.  

postalAddresses

postalAddress*

SalesOrderLine PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Order Line (ship to).  

orderLineDiscountType

discountType

SalesOrderLine Order Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Order Line (percent or amount). From the Trading Account.  

orderLineDiscountAmount

decimal

SalesOrderLine Order Line Discount Amount

 

X

 

 

 

Discount applicable to the Sales Order Line, expressed as an amount. From the Trading Account.  

orderLineDiscountPercent

decimal

SalesOrderLine Order Line Discount Percent

 

X

 

 

 

Discount applicable to the Sales Order Line, expressed as a percentage. From the Trading Account.  

orderLineSubtotalDiscountType

discountType

SalesOrderLine Order Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Order lines (percent or amount) of which this Line is part.  

orderLineSubtotalDiscountAmount

decimal

SalesOrderLine Order Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Order Line, expressed as an amount.  

orderLineSubtotalDiscountPercent

decimal

SalesOrderLine Order Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Order Line, expressed as a percentage.  

fobPoint

string

SalesOrderLine FOB Point

 

X

 

 

 

The FOB point applicable to the Sales Order Line. FOB is an abbreviation for Free On Board. The term FOB is used when shipping goods, to indicate who pays loading and transportation costs, and/or the point at which the responsibility of the goods transfers from shipper to buyer  

actualPrice

decimal

SalesOrderLine Actual Price

 

 

 

 

 

The actual price of the Commodity ordered on the Sales Order Line (e.g. after discounts or adjustments). In order currency.  

netTotal

decimal

SalesOrderLine Net Total

 

 

 

 

 

Total value of the Sales Order Line, including discounts and charges, excluding tax (e.g. quantity * actual price). In order currency. Could be calculated.  

chargesTotal

decimal

SalesOrderLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Order Line (e.g. finance charges, interest). In order currency.  

discountTotal

decimal

SalesOrderLine Discount Total

 

 

 

 

 

Total discounts applied to the order line. In order currency  

taxCodes

taxCode*

SalesOrderLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Order Line (default value from Sales Order). See TaxCode definition.  

priceTax

decimal

SalesOrderLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Order Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesOrderLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Order Line. In order currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesOrderLine Gross Total

 

 

 

 

 

Total value of the Sales Order Line, including discounts & tax & charges. In order currency.  

costTotal

decimal

SalesOrderLine Cost Total

 

X

 

 

 

Total cost of the Sales Order Line. In order currency.  

profitTotal

decimal

SalesOrderLine Profit Total

 

X

 

 

 

Total profit on the Sales Order Line (e.g. net total - cost total). In order currency.  

salesInvoiceLines

salesInvoiceLine*

SalesOrderLine Sales Invoice Line

 

X

 

 

association 

Sales Invoice Line(s) associated with the Sales Order Line. See SalesInvoiceLine definition.  

receipts

receipt*

SalesOrderLine Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Sales Order Line See Receipt definition.  

receiptLines

receiptLine*

SalesOrderLine ReceiptLine

 

X

 

 

association 

A link to the (cash) receipt line(s) associated with this Sales Order Line. See ReceiptLine definition.  

buyerContact

contact

SalesOrderLine Buyer Contact

 

X

 

 

reference 

Link to the Sales Order Line originator (buyer Contact). See Contact definition. This could be derived from the Sales Order  

project

project

SalesOrderLine Project

 

X

 

 

reference 

Identifier of the Project this Sales Order Line is for. See Project definition.  

projectLine

projectLine

SalesOrderLine ProjectLine

 

X

 

 

reference 

Project Line value for this Sales Order Line. See Project Line definition. Some applications may not have Project Lines.  

salesOrderDeliveryLines

salesOrderDeliveryLine*

SalesOrderLine SalesOrderDeliveryLine

 

X

 

 

association 

Link to the Delivery (dispatch) Line against the Sales Order Line. See SalesOrderDeliveryLine definition.  

bomLine

normalizedString

SalesOrderLine BOM Line

 

X

 

 

 

BOM Line associated with the Sales Order Line. The BOM Line resource will be defined in the future. Not all applications support this feature.  

financialAccounts

financialAccount*

SalesOrderLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Order Line. See FinancialAccount definition. This could be derived from the Sales Order  

costCentres

costCentre*

SalesOrderLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Order Line. See Cost Centre definition.  

departments

department*

SalesOrderLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Order Line. See Department definition.  

notes

note*

SalesOrderLine Note

 

X

 

 

child 

Notes associated with a Sales Order Line. 

Top  

Resource salesQuotation

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesQuotation Active Flag

 

 

 

 

 

Flag to indicate if the Sales Quotation is an active one. Default = True  

reference

normalizedString

SalesQuotation Reference

X

 

 

 

 

Reference for the Sales Quotation. 

reference2

normalizedString

SalesQuotation Reference2

 

X

 

 

 

Additional reference for the Sales Quotation. 

status

salesQuotationStatus

SalesQuotation Status

 

X

 

 

 

Status of the Sales Quotation 

statusFlag

boolean

SalesQuotation Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Quotation on hold (or blocked), off hold). True is on hold, False is not on hold. Default value is False.  

statusFlagText

normalizedString

SalesQuotation Status Flag Text

 

X

 

 

 

Sales Quotation status flag text. Default = On Hold  

tradingAccount

tradingAccount

SalesQuotation Customer TradingAccount

 

X

 

 

reference 

Link to the Sales Quotation Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesQuotation Customer Reference

 

X

 

 

 

Customer own reference for the Sales Quotation (e.g. a PO number).  

opportunity

opportunity

SalesQuotation Opportunity

 

X

 

 

reference 

Opportunity linked to the Sales Quotation (if any). See Opportunity definition.  

pricelist

priceList

SalesQuotation PriceList

 

X

 

 

reference 

Link to the Price List used when generating the Sales Quotation. See PriceList definition.  

type

normalizedString

SalesQuotation Type

 

X

 

 

 

The Sales Quotation type. 

copyFlag

boolean

SalesQuotation Copy Flag

 

 

 

 

 

Indicates if this Sales Quotation is a copy or not. Default is false (no)  

originatorDocument

salesQuotationOriginatorDocument--choice

SalesQuotation Originator Document Reference

 

X

 

 

reference 

Reference to another Sales Quotation if required (e.g. if Quotation is a copy, then this will show which Quotation was copied, If this is a replacement Quotation this will show the original Quotation).  

postalAddresses

postalAddress*

SalesQuotation PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Quotation. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc. These are also stored on SalesQuotationLines  

deliveryMethod

normalizedString

SalesQuotation Delivery Method

 

X

 

 

 

Delivery method to be employed for Sales Quotation (e.g. Courier, Collection, etc)  

deliveryRule

boolean

SalesQuotation Delivery Rule

 

X

 

 

 

Flag to indicate if the Quotation has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryTerms

normalizedString

SalesQuotation Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

SalesQuotation Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

dueDate

date

SalesQuotation Due Date

 

X

 

 

 

Date the Quotation is due by the Customer. Delivery date may be different to the Customer due date.  

carrierCompany

normalizedString

SalesXXX Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Sales Quotation. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

SalesXXX Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Quotation. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesXXX Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Quotation currency.  

carrierTaxPrice

decimal

SalesXXX Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Quotation currency.  

carrierTotalPrice

decimal

SalesXXX Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + tax). In Quotation currency.  

carrierSalesInvoices

salesInvoice*

SalesXXX Carrier SalesInvoices

 

X

 

 

association 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoices

purchaseInvoice*

SalesXXX Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesXXX Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Quotation. See TaxCode definition.  

carrierReference

normalizedString

SalesXXX Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

SalesQuotation Currency

 

 

 

 

 

The currency of the Sales Quotation (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

SalesQuotation OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesQuotation OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Quotation Currency into Sales Quotation OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesQuotation OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Quotation Currency to Sales Quotation OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Quotation Values in Sales Quotation Currency / Sales Quotation Operating Company Currency Exchange Rate = Sales Quotation Values in Sales Quotation OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesQuotation OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Quotation Currency to Sales Quotation OperatingCompany Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesQuotation Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Customer Trading Account on the Sales Quotation. ISO 4217. Could be derived from Quotation currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesQuotation Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Quotation currency into the Customer Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesQuotation Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Quotation Currency to Sales Quotation Customer Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Quotation Values in Sales Quotation Currency / Sales Quotation Customer TradingAccount Currency Exchange Rate = Sales Quotation Values in Sales Quotation Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesQuotation Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Quotation Currency to Customer Trading Account Currency, if different. Default = System date  

date

date

SalesQuotation Date

 

 

 

 

 

Date the Sales Quotation was placed. 

time

time

SalesQuotation Time

 

X

 

 

 

Time the Sales Quotation was placed. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

validity

decimal

SalesQuotation Validity

 

X

 

 

 

Period the Sales Quotation is valid for (days from Quotation Date).  

expirationDate

date

SalesQuotation Expiration Date

 

X

 

 

 

The expiration date of the Sales Quotation (SalesQuotation Date + Validity).  

taxCodes

taxCode*

SalesQuotation Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Quotation. See TaxCode definition.  

buyerContact

contact

SalesQuotation Buyer Contact

 

X

 

 

reference 

Link to the Contact at Customer who placed the Sales Quotation. See Contact definition. Default = Primary TradingAccount Contact  

salesPersons

salesPerson*

SalesQuotation SalesPersons

 

X

 

 

association 

Sales person associated with the Sales Quotation. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

user

normalizedString

SalesQuotation User

 

X

 

 

 

Link to the user who placed the Sales Quotation. The user resource will be defined in the future.  

salesQuotationLines

salesQuotationLine*

SalesQuotation SalesQuotationLine

 

 

 

 

child 

Sales Quotation Line detail (e.g. items on the Sales Quotation). See SalesQuotationLine definition.  

lineCount

decimal

SalesQuotation Line Count

 

 

 

 

 

The number of lines on the Sales Quotation. Should be auto-populated. Used as a cross reference to ensure Quotation integrity.  

orderDiscountType

discountType

SalesQuotation Order Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Quotation (percent or amount). From the Trading Account.  

orderDiscountAmount

decimal

SalesQuotation Order Discount Amount

 

X

 

 

 

Discount applicable to the Sales Quotation expressed as an amount. From the Trading Account.  

orderDiscountPercent

decimal

SalesQuotation Order Discount Percent

 

X

 

 

 

Discount applicable to the Sales Quotation expressed as a percent. From the Trading Account.  

orderAdditionalDiscount1Type

discountType

SalesQuotation Order Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Quotation (percent or amount)  

orderAdditionalDiscount1Amount

decimal

SalesQuotation Order Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Sales Quotation expressed as an amount.  

orderAdditionalDiscount1Percent

decimal

SalesQuotation Order Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Sales Quotation expressed as a percent.  

orderAdditionalDiscount2Type

discountType

SalesQuotation Order Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Quotation (percent or amount)  

orderAdditionalDiscount2Amount

decimal

SalesQuotation Order Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Sales Quotation expressed as an amount.  

orderAdditionalDiscount2Percent

decimal

SalesQuotation Order Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Sales Quotation expressed as a percent.  

text1

string

SalesQuotation Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Quotation. Header text.  

text2

string

SalesQuotation Text2

 

X

 

 

 

Further text/commentary for the Sales Quotation. Footer text.  

netTotal

decimal

SalesQuotation Net Total

 

 

 

 

 

Total value of the Sales Quotation, including discounts, excluding tax. In Quotation currency.  

discountTotal

decimal

SalesQuotation Discount Total

 

 

 

 

 

Total discounts applied to the Quotation. In Quotation currency  

chargesTotal

decimal

SalesQuotation Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Quotation (e.g. finance charges, interest). In Quotation currency.  

taxTotal

decimal

SalesQuotation Tax Total

 

 

 

 

 

Total tax applicable to the Sales Quotation. In Quotation currency.  

grossTotal

decimal

SalesQuotation Gross Total

 

 

 

 

 

Total value of the Sales Quotation, including tax & discounts & charges. In Quotation currency.  

costTotal

decimal

SalesQuotation Cost Total

 

X

 

 

 

Total cost of the Sales Quotation. In Quotation currency.  

profitTotal

decimal

SalesQuotation Profit Total

 

X

 

 

 

Total profit on the Sales Quotation (e.g. net total - cost total). In Quotation currency.  

contract

string

SalesQuotation Contract

 

X

 

 

 

Reference to a contract associated with the Sales Quotation. If Contracts aren't used there may be an estimate instead - this would contain the reference of the estimate.  

projects

project*

SalesQuotation Project

 

X

 

 

association 

Identifier of the Project this Sales Quotation is for. See Project definition.  

projectLines

projectLine*

SalesQuotation ProjectLine

 

X

 

 

association 

Project Line value for this Sales Quotation. See Project Line definition. Some applications may not have Project Lines.  

cases

case*

SalesQuotation Cases

 

X

 

 

association 

The reference of the case associated with the Sales Quotation, e.g. if the Quotation is for repair/fix services. A Case entity has been defined to support the F2F process.  

fulfillmentLocations

location*

SalesQuotation Fulfilment Location

 

X

 

 

association 

The Location from which the Sales Quotation will be fulfilled (e.g. the warehouse holding the Commodity). See Location definition. May be held at Line level instead.  

financialAccounts

financialAccount*

SalesQuotation FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Quotation. See FinancialAccount definition. Could come from the Trading Account.  

costCentres

costCentre*

SalesQuotation CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Quotation. See Cost Centre definition.  

departments

department*

SalesQuotation Departments

 

X

 

 

association 

Department(s) associated with this Sales Quotation. See Department definition.  

interactions

interaction*

SalesQuotation Interactions

 

X

 

 

association 

Interaction(s) associated with the Sales Quotation. See Interaction definition.  

notes

note*

SalesQuotation Note

 

X

 

 

child 

Notes associated with a Sales Quotation. 

Top  

Resource salesQuotationLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesQuotation

salesQuotation

SalesQuotationLine Sales Quotation

 

 

 

 

parent 

The parent Sales Quotation 

active

boolean

SalesQuotationLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Quotation Line is an active one. Default = True  

reference

normalizedString

SalesQuotationLine Reference

X

 

 

 

 

Reference for the Sales Quotation Line. 

reference2

normalizedString

SalesQuotationLine Reference2

 

X

 

 

 

Additional reference for the Sales Quotation Line.  

number

decimal

SalesQuotationLine Number

 

 

 

 

 

The number of the Sales Quotation Line. For sequencing and ordering of lines.  

status

salesQuotationStatus

SalesQuotationLine Status

 

X

 

 

 

Status of the Sales Quotation Line. 

type

lineType

SalesQuotationLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Quotation Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

deliveryTerms

normalizedString

SalesQuotationLine Delivery Terms

 

X

 

 

 

The terms for Delivery for this Sales Quotation Line. Also on Sales Quotation but may be different per Line.  

commodity

commodity

SalesQuotationLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Quotation Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

SalesQuotationLine Text

 

X

 

 

 

Text applicable to the Sales Quotation Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Quotation Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesQuotationLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Sales Quotation Line. See Variant definition.  

commodityDimension

commodityDimension

SalesQuotationLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the Sales Quotation Line. See Dimension definition.  

associatedCommodity

commodity

SalesQuotationLine Associated Commodity

 

X

 

 

reference 

Link to the Commodity associated with the Sales Quotation Line, e.g. if Line is for service to another Commodity. See Commodity definition.  

fulfillmentLocation

location

SalesQuotationLine Fulfillment Location

 

X

 

 

reference 

The Location from which the Sales Quotation Line will be fulfilled (e.g. the warehouse holding the Commodity). See Location definition.  

deliveryDate

date

SalesQuotationLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

dueDate

date

SalesQuotationLine Due Date

 

X

 

 

 

Date the Sales Quotation Line is due by the Customer. Delivery date may be different to the Customer due date.  

carrierTradingAccount

tradingAccount

SalesXXXLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Quotation Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesXXXLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Quotation currency.  

carrierTaxPrice

decimal

SalesXXXLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Quotation currency.  

carrierTotalPrice

decimal

SalesXXXLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + tax). In Quotation currency.  

carrierSalesInvoiceLine

salesInvoiceLine

SalesXXXLine Carrier SalesInvoiceLine

 

X

 

 

reference 

A link to the Sales Invoice Line generated to recharge the carriage to the Customer. See SalesInvoiceLine definition.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

SalesXXXLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the purchase Invoice Line charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoiceLine definition.  

carrierTaxCodes

taxCode*

SalesXXXLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Quotation Line. See TaxCode definition.  

carrierReference

normalizedString

SalesXXXLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

unitOfMeasure

unitOfMeasure

SalesQuotationLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

SalesQuotationLine Quantity

 

 

 

X

 

The quantity of the Commodity ordered on the Sales Quotation Line.  

initialPrice

decimal

SalesQuotationLine Initial Price

 

 

 

 

 

The initial price of the Commodity ordered on the Sales Quotation Line (e.g. before discounts). In order currency.  

pricelist

priceList

SalesQuotationLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Sales Quotation Line. See PriceList definition.  

postalAddresses

postalAddress*

SalesQuotationLine PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Quotation Line (ship to).  

orderLineDiscountType

discountType

SalesQuotationLine Order Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Quotation Line (percent or amount). From the Trading Account.  

orderLineDiscountAmount

decimal

SalesQuotationLine Order Line Discount Amount

 

X

 

 

 

Discount applicable to the Sales Quotation Line, expressed as an amount. From the Trading Account.  

orderLineDiscountPercent

decimal

SalesQuotationLine Order Line Discount Percent

 

X

 

 

 

Discount applicable to the Sales Quotation Line, expressed as a percentage. From the Trading Account.  

orderLineSubtotalDiscountType

discountType

SalesQuotationLine Order Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Quotation lines (percent or amount) of which this Line is part.  

orderLineSubtotalDiscountAmount

decimal

SalesQuotationLine Order Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Quotation Line, expressed as an amount.  

orderLineSubtotalDiscountPercent

decimal

SalesQuotationLine Order Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Quotation Line, expressed as a percentage.  

actualPrice

decimal

SalesQuotationLine Actual Price

 

 

 

 

 

The actual price of the Commodity ordered on the Sales Quotation Line (e.g. after discounts or adjustments). In Quotation currency.  

netTotal

decimal

SalesQuotationLine Net Total

 

 

 

 

 

Total value of the Sales Quotation Line, including discounts, excluding tax (e.g. quantity * actual price). In Quotation currency. Could be calculated.  

chargesTotal

decimal

SalesQuotationLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Quotation Line (e.g. finance charges, interest). In Quotation currency.  

discountTotal

decimal

SalesQuotationLine Discount Total

 

 

 

 

 

Total discounts applied to the quotation line. In quotation currency  

taxCodes

taxCode*

SalesQuotationLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Quotation Line (default value from Sales Quotation). See TaxCode definition.  

priceTax

decimal

SalesQuotationLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Quotation Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesQuotationLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Quotation Line. In Quotation currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesQuotationLine Gross Total

 

 

 

 

 

Total value of the Sales Quotation Line, including discounts & tax & charges. In Quotation currency.  

costTotal

decimal

SalesQuotationLine Cost Total

 

X

 

 

 

Total cost of the Sales Quotation Line. In Quotation currency.  

profitTotal

decimal

SalesQuotationLine Profit Total

 

X

 

 

 

Total profit on the Sales Quotation Line (e.g. net total - cost total). In Quotation currency.  

buyerContact

contact

SalesQuotationLine Buyer Contact

 

X

 

 

reference 

Link to the Sales Quotation Line originator (buyer Contact). See Contact definition. This could be derived from the Sales Quotation  

project

project

SalesQuotationLine Project

 

X

 

 

reference 

Identifier of the Project this Sales Quotation Line is for. See Project definition.  

projectLine

projectLine

SalesQuotationLine ProjectLine

 

X

 

 

reference 

Project Line value for this Sales Quotation Line. See Project Line definition. Some applications may not have Project Lines.  

bomLine

normalizedString

SalesQuotationLine BOM Line

 

X

 

 

 

BOM Line associated with the Sales Quotation Line. The BOM Line resource will be defined in the future. Not all applications support this feature.  

financialAccounts

financialAccount*

SalesQuotationLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Quotation Line. See FinancialAccount definition. This could be derived from the Sales Quotation  

costCentres

costCentre*

SalesQuotationLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Quotation Line. See Cost Centre definition.  

departments

department*

SalesQuotationLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Quotation Line. See Department definition.  

notes

note*

SalesQuotationLine Note

 

X

 

 

child 

Notes associated with a Sales Quotation Line. 

Top  

Resource commodity

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Commodity Active Flag

 

 

 

 

 

Flag to indicate if the Commodity is an active one. Default = True  

commodityGroup

commodityGroup

Commodity CommodityGroup

 

 

 

 

reference 

Identifier of the Commodity group this Commodity belongs to. See CommodityGroup definition. Commodities can only belong to one Commodity Group.  

commodityIdentifierType

commodityCommodityIdentifierType

Commodity CommodityIdentifier Type

 

X

 

 

 

Type of the Commodity Identifier associated with this Commodity (if any) (e.g. Total, Batch (lot), Serial Number, Serial from Batch/Lot, Unknown). Default = Total  

commodityIdentifiers

commodityIdentifier*

Commodity CommodityIdentifier

 

X

 

 

child 

Link to the Commodity Identifier(s) for this Commodity, if it is traced to that level of detail. See CommodityIdentifier definition.  

reference

normalizedString

Commodity Reference

X

 

 

 

 

Reference for the Commodity (typically the one used by the buying organization).  

reference2

normalizedString

Commodity Reference2

 

X

 

 

 

Another reference for the Commodity. 

status

normalizedString

Commodity Status

 

X

 

 

 

Status of the Commodity. 

name

normalizedString

Commodity Name

 

 

 

X

 

Short name for the Commodity. 

shortName

normalizedString

Commodity Short Name

 

X

 

 

 

A shorter name for the Commodity. 

description

normalizedString

Commodity Description

 

X

 

 

 

The Commodity description. 

alternativeDescription1

string

Commodity Alternative Description1

 

X

 

 

 

An alternative Commodity description (e.g. buying or selling descriptions may be different).  

alternativeDescription2

string

Commodity Alternative Description2

 

X

 

 

 

Another alternative Commodity description (e.g. could be used for special Delivery instructions, handling instructions, or alternative language descriptions, etc).  

type

commodityType

Commodity Type

 

 

 

X

 

The Commodity type (e.g. product, service). Default value should come from CommodityGroup. Product Stock (e.g. finished goods and/or raw materials) Product Non Stock (e.g. Misc or expense). Service (contracts). Bill Of Material (Manufactured Item) (e.g. assembled Kit). (Built to Order) Kit. Subcontract Description (e.g. comment). User Defined. Unknown. Default = Unknown  

unitOfMeasure

unitOfMeasure

Commodity UnitOfMeasure

 

 

 

 

reference 

Link to the Unit of Measure (pack size / quantity) for the Commodity (e.g. each, six-pack, case, etc). Also known as stocking Unit of Measure. See UnitOfMeasure definition.  

buyingAllowedFlag

boolean

Commodity Buying Allowed Flag

 

X

 

 

 

Flag to indicate that this Commodity can be bought i.e. can be used on purchase orders/requisitions. Default = Yes  

buyingUnitOfMeasure

unitOfMeasure

Commodity Buying UnitOfMeasure

 

X

 

 

reference 

Link to the Unit of Measure (pack size / quantity) for the Commodity used during buying (e.g. each, six-pack, case, etc). See UnitOfMeasure definition. Default = Commodity UnitOfMeasure  

buyingUnitOfMeasureNumber

decimal

Commodity Buying UnitOfMeasure Number

 

X

 

 

 

The number (quantity) of items in a pack of the Commodity (e.g. 1, 6, 24, etc). Default = 1  

sellingAllowedFlag

boolean

Commodity Selling Allowed Flag

 

X

 

 

 

Flag to indicate that this Commodity can be sold i.e. can be used on sales orders/quotations. Default = Yes  

sellingUnitOfMeasure

unitOfMeasure

Commodity Selling UnitOfMeasure

 

X

 

 

reference 

Link to the Unit of Measure (pack size / quantity) for the Commodity used during selling/retail (e.g. each, six-pack, case, etc). See UnitOfMeasure definition. Default = Commodity UnitOfMeasure  

sellingUnitOfMeasureNumber

decimal

Commodity Selling UnitOfMeasure Number

 

X

 

 

 

The number (quantity) of items in a pack of the Commodity (e.g. 1, 6, 24, etc). 1  

packingUnitOfMeasure

unitOfMeasure

Commodity Packing UnitOfMeasure

 

X

 

 

reference 

Link to the Unit of Measure (pack size / quantity) for the Commodity used during packing/dispatch (e.g. each, six-pack, case, etc). See UnitOfMeasure definition. This could be the default or buying Unit of Measure.  

packingUnitOfMeasureNumber

decimal

Commodity Packing UnitOfMeasure Number

 

X

 

 

 

The number (quantity) of items in a pack of the Commodity (e.g. 1, 6, 24, etc).  

catalogueNumber

normalizedString

Commodity Catalogue Number

 

X

 

 

 

Reference for the Commodity in a Supplier catalogue.  

supplierTradingAccounts

tradingAccount*

Commodity Supplier TradingAccounts

 

X

 

 

association 

Link to the Commodity Supplier trading account. See TradingAccount definition.  

supplierReference

normalizedString

Commodity Supplier Reference

 

X

 

 

 

Reference for the Commodity as used by the Supplier.  

manufacturerCompany

normalizedString

Commodity Manufacturer Company

 

X

 

 

 

Link to the Company associated with manufacturing the Commodity. See Company definition.  

manufacturerReference

normalizedString

Commodity Manufacturer Reference

 

X

 

 

 

Reference for the Commodity as used by the manufacturer.  

material

string

Commodity Material

 

X

 

 

 

Material from which the Commodity is made. 

countryOfOrigin

normalizedString

Commodity Country Of Origin

 

X

 

 

 

The country where the Commodity originated. ISO 3166-1 alpha-2 country codes only Could default from CommodityGroup.  

weight

decimal

Commodity Weight

 

X

 

 

 

Weight of the Commodity. In system default weight unit (metric or imperial, tonnes, quintals, etc).  

weightKg

decimal

Commodity Weight KG

 

X

 

 

 

Weight of the Commodity in SI units (Kilograms). In kilograms - may be different to the standard weight.  

variants

commodityVariant*

Commodity Variants

 

X

 

 

association 

The Variant of the Commodity (e.g. colour or size). See Variant definition.  

dimensions

commodityDimension*

Commodity Dimensions

 

X

 

 

association 

The physical Dimension of the Commodity (e.g. height). See Dimension definition.  

classification

normalizedString

Commodity Classification

 

X

 

 

 

Classification of the Commodity. Based on standard classification system (Intrastat in EU)  

taxCodes

taxCode*

Commodity Tax Code

 

X

 

 

association 

Tax code governing the tax treatment of this Commodity (e.g. VAT, GST). See TaxCode definition.  

financialAccounts

financialAccount*

Commodity FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Commodity. See FinancialAccount definition.  

costCentres

costCentre*

Commodity CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Commodity. See Cost Centre definition.  

departments

department*

Commodity Departments

 

X

 

 

association 

Department(s) associated with this Commodity. See Department definition.  

dutyApplicableFlag

boolean

Commodity Duty Applicable Flag

 

X

 

 

 

Flag to indicate if duty (import tax?) is applicable to this Commodity. Default = False  

dutyRate

decimal

Commodity Duty Rate

 

X

 

 

 

Rate of duty applicable to this Commodity (if duty is applicable).  

tradeIdentificationNumber

normalizedString

Commodity Trade Identification Number

X

X

 

 

 

The GTIN (global trade identification number) for the Commodity (e.g. EAN-13, UPC-13 for barcodes). Used for handling bar codes.  

replacement

commodity

Commodity Replacement

 

X

 

 

reference 

If this Commodity has been superseded this is a link to the new Commodity. See Commodity definition.  

replacementDate

date

Commodity Replacement Date

 

X

 

 

 

For superseded/replaced commodities, this is the start date of the replacement.  

leadTime

decimal

Commodity Lead Time

 

X

 

 

 

The (average) number of days to supply the Commodity from (all) Suppliers.  

cost

decimal

Commodity Cost

 

X

 

 

 

Depending on the costing method used, this is the cost of the commodity (e.g. average cost)  

associatedChildCommodities

commodity*

Associated Child Commodity

 

X

 

 

child 

Link to child Commodity associated with this Commodity (e.g. kit parts). Commodities can be nested to create Commodity hierarchies, typically for Kit or BOM items.  

associatedParentCommodity

commodity

Commodity Associated Parent Commodity

 

X

 

 

parent 

Link to parent Commodity associated with this Commodity. Commodities can be nested to create Commodity hierarchies, typically for Kit or BOM items.  

version

normalizedString

Commodity Version

 

X

 

 

 

The version number of this Commodity. 

commissionType

commodityCommissionType

Commodity Commission Type

 

X

 

 

 

Flag to indicate the type of commission applicable to this Commodity (percent or amount)  

commissionAmount

decimal

Commodity Commission Amount

 

X

 

 

 

Commission applicable to the Commodity expressed as an amount.  

commissionPercent

decimal

Commodity Commission Percent

 

X

 

 

 

Commission applicable to the Commodity expressed as a percent.  

interactions

interaction*

Commodity Interactions

 

X

 

 

association 

Interaction(s) associated with the Commodity. See Interaction definition.  

opportunities

opportunity*

Commodity Opportunity

 

X

 

 

association 

Opportunities associated with the Commodity. See Opportunity definition.  

salesQuotationLines

salesQuotationLine*

Commodity Sales Quotation Line

 

X

 

 

association 

Sales Quotation Line(s) associated with the Commodity. See SalesQuotationLine definition.  

salesOrderLines

salesOrderLine*

Commodity Sales Order Line

 

X

 

 

association 

Sales Order Line(s) associated with the Commodity. See SalesOrderLine definition.  

salesOrderDeliveryLines

salesOrderDeliveryLine*

Commodity Sales Order Delivery Line

 

X

 

 

association 

Sales Order Delivery Line(s) associated with the Commodity. See SalesOrderDeliveryLine definition.  

salesInvoiceLines

salesInvoiceLine*

Commodity Sales Invoice Line

 

X

 

 

association 

Sales Invoice Line(s) associated with the Commodity. See SalesInvoiceLine definition.  

salesReturnLines

salesReturnLine*

Commodity Sales Return Line

 

X

 

 

association 

Sales Return Line(s) associated with the Commodity. See SalesReturnLine definition.  

salesReturnDeliveryLines

salesReturnDeliveryLine*

Commodity Sales Return Delivery Line

 

X

 

 

association 

Sales Return Delivery Line(s) associated with the Commodity. See SalesReturnDeliveryLine definition.  

salesCreditLines

salesCreditLine*

Commodity Sales Credit Line

 

X

 

 

association 

Sales Credit Line(s) associated with the Commodity. See SalesCreditLine definition.  

purchaseRequisitionLines

purchaseRequisitionLine*

Commodity Purchase Requisition Line

 

X

 

 

association 

Purchase Requisition Line(s) associated with the Commodity. See PurchaseRequisitionLine definition.  

purchaseOrderLines

purchaseOrderLine*

Commodity Purchase Order Line

 

X

 

 

association 

Purchase Order Line(s) associated with the Commodity. See PurchaseOrderLine definition.  

purchaseOrderDeliveryLines

purchaseOrderDeliveryLine*

Commodity Purchase Order Delivery Line

 

X

 

 

association 

Purchase Order Delivery Line(s) associated with the Commodity. See PurchaseOrderDeliveryLine definition.  

purchaseInvoiceLines

purchaseInvoiceLine*

Commodity Purchase Invoice Line

 

X

 

 

association 

Purchase Invoice Line(s) associated with the Commodity. See PurchaseInvoiceLine definition.  

purchaseReturnLines

purchaseReturnLine*

Commodity Purchase Return Line

 

X

 

 

association 

Purchase Return Line(s) associated with the Commodity. See PurchaseReturnLine definition.  

purchaseReturnDeliveryLines

purchaseReturnDeliveryLine*

Commodity Purchase Return Delivery Line

 

X

 

 

association 

Purchase Return Delivery Line(s) associated with the Commodity. See PurchaseReturnDeliveryLine definition.  

purchaseCreditLines

purchaseCreditLine*

Commodity Purchase Credit Line

 

X

 

 

association 

Purchase Credit Line(s) associated with the Commodity. See PurchaseCreditLine definition.  

receiptLines

receiptLine*

Commodity Receipt Line

 

X

 

 

association 

Receipt Line(s) associated with the Commodity. See Receipt Line definition.  

cases

case*

Commodity Cases

 

X

 

 

association 

Case(s) associated with the Commodity. See Case definition.  

pricelists

priceList*

Commodity Price List

 

X

 

 

association 

Price list(s) associated with the Commodity. See Price List definition.  

prices

price*

Commodity Price

 

X

 

 

association 

Prices associated with the Commodity. See Price definition.  

notes

note*

Commodity Note

 

X

 

 

child 

Notes associated with a Commodity. 

Top  

Resource commodityGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

CommodityGroup Active Flag

 

 

 

 

 

Flag to indicate if the Commodity Group is an active one. Default = True  

type

commodityGroupType

CommodityGroup Commodity Type

 

X

 

X

 

The Commodity type for Commodity associated with this group (e.g. Products, Service, Misc, etc). Product Stock (e.g. finished goods and/or raw materials) Product Non Stock (e.g. Misc or expense). Service. Bill Of Material (Manufactured Item) (e.g. assembled Kit). (Built to Order) Kit. Subcontract. Description (e.g. comment). User Defined. Unknown. Default = Unknown  

reference

normalizedString

CommodityGroup Reference

X

 

 

 

 

Reference for the Commodity Group. 

reference2

normalizedString

CommodityGroup Reference2

 

X

 

 

 

Another reference for the Commodity Group. 

name

normalizedString

CommodityGroup Name

 

 

 

X

 

Name of the Commodity Group. 

description

normalizedString

CommodityGroup Description

 

X

 

 

 

A longer description of the Commodity Group. 

countryOfOrigin

normalizedString

CommodityGroup Country Of Origin

 

X

 

 

 

The country where the Commodity Group originated. ISO 3166-1 alpha-2 country codes only  

financialAccounts

financialAccount*

CommodityGroup FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Commodity Group. See FinancialAccount definition.  

costCentres

costCentre*

CommodityGroup CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Commodity Group. See Cost Centre definition.  

departments

department*

CommodityGroup Departments

 

X

 

 

association 

Department(s) associated with this Commodity Group. See Department definition.  

commodities

commodity*

CommodityGroup Commodity

 

X

 

 

association 

Commodity(s) associated with the Commodity Group. Commodities can only belong to one Commodity Group.  

notes

note*

CommodityGroup Note

 

X

 

 

child 

Note(s) reference with the Commodity Group. See Note definition.  

Top  

Resource priceList

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PriceList Active Flag

 

 

 

 

 

Flag to indicate if the Price List is an active one. Default = True  

type

priceListType

PriceList Type

 

X

 

X

 

Flag to indicate if the Price List is for selling or for buying.  

name

normalizedString

PriceList Name

 

 

 

X

 

Name of the Price List (e.g. trade, retail, etc). 

reference

normalizedString

PriceList Reference

X

 

 

 

 

Reference for the Price List 

description

normalizedString

PriceList Description

 

X

 

 

 

A longer description of the Price List. 

calculationMethod

normalizedString

PriceList Calculation Method

 

X

 

 

 

The calculation method used to calculate prices associated with this Price List, e.g. standard, discount, cost plus, etc  

calculationType

priceListCalculationType

PriceList CalculationType

 

X

 

 

 

Flag to indicate the type of calculation (percent or amount).  

calculationAmount

decimal

PriceList Calculation Amount

 

X

 

 

 

Calculation value expressed as an amount. 

calculationPercent

decimal

PriceList Calculation Percent

 

X

 

 

 

Calculation value expressed as an amount. 

roundingMethod

normalizedString

PriceList Rounding Method

 

X

 

 

 

Rounding method (e.g. up, down, none) to be used when calculating prices associated with this Price List.  

taxCodes

taxCode*

PriceList TaxCode

 

X

 

 

association 

Tax code governing the tax treatment of this Price List (e.g. VAT). See TaxCode definition.  

pricesIncludesTax

boolean

PriceList Prices Includes Tax

 

X

 

 

 

Flag to indicate if the prices associated with the Price List includes tax. Default = False  

currency

normalizedString

PriceList Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) the Price List is in. ISO 4217.  

operatingCompanyCurrency

normalizedString

PriceList OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PriceList OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Price List Currency into Price List OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Pricelist OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Price List Currency to Price List OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Price List Values in Price List Currency / Price List Operating Company Currency Exchange Rate = Price List Values in Price List OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PriceList OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Price List Currency to Price List OperatingCompany Currency, if different. Default = System date  

startDate

date

PriceList Start Date

 

X

 

 

 

Date the Price List is valid from. 

endDate

date

PriceList End Date

 

X

 

 

 

Date the Price List is valid to. 

primacyIndicator

boolean

PriceList Primacy Indicator

 

 

 

 

 

A flag to indicate if the Price List is the primary/default Price List. If there are multiple Price Lists against a Commodity then this indicates which has primacy - only one can have primacy. The standard Price List is often the primary Price List. Default = False  

commodities

commodity*

PriceList Commodity

 

X

 

 

association 

Commodities on the Price List. See Commodity definition  

tradingAccounts

tradingAccount*

PriceList TradingAccount

 

X

 

 

association 

Trading Account(s) associated with the price list. See TradingAccount definition.  

prices

price*

PriceList Prices

 

 

 

 

association 

Prices for the price list 

notes

note*

PriceList Note

 

X

 

 

child 

Notes associated with the Price List. 

Top  

Resource price

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Price Active Flag

 

 

 

 

 

Flag to indicate if the Price is an active one. Default = True  

reference

normalizedString

Price Reference

X

 

 

 

 

Reference for the Price. 

status

normalizedString

Price Status

 

X

 

 

 

Status of the Price (e.g. confirmed, provisional, amended, etc) - content will be application specific.  

customerSupplierFlag

supplierFlag

Price Customer Supplier Flag

 

X

 

 

 

A flag to indicate if the Price is for a Customer or Supplier. To support Customer (or Supplier) specific Price.  

tradingAccounts

tradingAccount*

Price Trading Account

 

X

 

 

association 

A link to the Trading Account associated with this Price. See Supplier definition.  

commodity

commodity

Price Commodity

 

 

 

X

reference 

Link to the Commodity this Price is for. See Commodity definition.  

pricelist

priceList

Price PriceList

 

 

 

 

reference 

A link to the associated Price List (e.g. trade, retail, etc). See PriceList definition.  

unitOfMeasure

unitOfMeasure

Price UnitOfMeasure

 

 

 

 

reference 

A link to the Unit of Measure for this Price (e.g. each, pack of 10, etc). See UnitOfMeasure definition.  

locations

location*

Price Locations

 

X

 

 

association 

The Location to which the Price applies (if Location-specific pricing supported). See Location definition.  

postalAddress

postalAddress

Price PostalAddress

 

X

 

 

child 

The Postal Address of the Customer (or Supplier) to which this Price applies (if address-specific pricing supported). See PostalAddress definition. Must be an address associated with a Customer (or Supplier).  

currency

normalizedString

Price Currency

 

 

 

 

 

The currency (e.g. GBP, USD, EUR) the Price is in. ISO 4217.  

operatingCompanyCurrency

normalizedString

Price OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Price OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Price Currency into Price OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Price OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Price Currency to Price OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Price Values in Price Currency / Price Operating Company Currency Exchange Rate = Price Values in Price OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Price OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Price Currency to Price OperatingCompany Currency, if different. Default = System date  

decimalPlaces

decimal

Price Decimal Places

 

X

 

 

 

The decimal places the Price is stored to. Could default from system settings. Default = 2  

price

decimal

Price

 

 

 

X

 

The Price. 

includesTax

boolean

Price Includes Tax

 

X

 

 

 

Flag to indicate if the prices includes tax. Default = False  

startDate

date

Price Start Date

 

X

 

 

 

Date the Price list is valid from. 

endDate

date

Price End Date

 

X

 

 

 

Date the Price list is valid to. 

notes

note*

Price Note

 

X

 

 

child 

Notes associated with the Price. 

Top  

Resource unitOfMeasure

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

UnitOfMeasure Active Flag

 

 

 

 

 

Flag to indicate if the Unit of Measure is an active one. Default = True  

type

normalizedString

UnitOfMeasure Type

 

X

 

 

 

The type of Unit of Measure (e.g. selling, buying, expenses, payroll, weight, packing, etc)  

reference

normalizedString

UnitOfMeasure Reference

X

 

 

 

 

Reference for the Unit of Measure. 

reference2

normalizedString

UnitOfMeasure Reference2

 

X

 

 

 

Additional reference for the Unit of Measure. 

name

normalizedString

UnitOfMeasure Name

 

X

 

 

 

Name of the Unit of Measure (e.g. each, pack of 10, 100 litres, etc).  

shortName

normalizedString

UnitOfMeasure Short Name

 

X

 

 

 

A shorter name for the Unit of Measure. 

symbol

normalizedString

UnitOfMeasure Symbol

 

X

 

 

 

A symbol associated with the Unit of Measure (e.g. Kg, mm, cm, etc).  

description

normalizedString

UnitOfMeasure Description

 

X

 

 

 

A longer description of the Unit of Measure. 

baseNumber

decimal

UnitOfMeasure Base Number

 

 

 

 

 

Base quantity applicable to this Unit of Measure (e.g. each = 1, pack of 10 = 10, 100 litres = 100). Default 1  

baseFactorNumber

decimal

UnitOfMeasure Base Factor Number

 

 

 

 

 

The factored quantity applicable to this Unit of Measure (the multiplier). Default is same as base number.  

decimalPlaces

decimal

UnitOfMeasure Decimal Places

 

X

 

 

 

The decimal places allowed on the Unit of Measure. Default 0 (whole numbers only).  

tradeIdentificationNumber

normalizedString

UnitOfMeasure Trade Identification Number

X

X

 

 

 

The GTIN (global trade identification number) for the Unit of Measure (e.g. EAN-13, UPC-13 for barcodes). Used for handling bar codes on packs.  

weight

decimal

UnitOfMeasure Weight

 

X

 

 

 

Weight of the Unit of Measure (pack). In system default weight unit (metric or imperial, tonnes, quintals, etc).  

weightKg

decimal

UnitOfMeasure Weight KG

 

X

 

 

 

Weight of the Unit of Measure (pack) in SI units (Kilograms). In kilograms - may be different to the standard weight.  

dimensions

commodityDimension*

UnitOfMeasure Dimensions

 

X

 

 

association 

The Dimension of the Unit Of Measure (pack). See Dimension definition.  

primacyIndicator

boolean

UnitOfMeasure Primacy Indicator

 

 

 

 

 

A flag to indicate if the Unit of Measure is the primary/default UOM. If there are multiple units of measure against a Commodity then this indicates which has primacy - only one can have primacy. Default = False  

commodities

commodity*

UnitOfMeasure Commodity

 

X

 

 

association 

Links to those Commodities using this Unit of Measure. See Commodity definition.  

notes

note*

UnitOfMeasure Note

 

X

 

 

child 

Note(s) associated with the Unit of Measure. 

Top  

Resource opportunity

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Opportunity Active Flag

 

 

 

 

 

Flag to indicate if the Opportunity is an active one. Default = True  

status

opportunityStatus

Opportunity Status

 

X

 

 

 

Status of the Opportunity (e.g. open, won, lost, etc).  

statusFlag

boolean

Opportunity Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Opportunity on hold (or blocked), off hold). True is on hold, False is not on hold. Default value False.  

statusFlagText

normalizedString

Opportunity Status Flag Text

 

X

 

 

 

Opportunity status flag text. Default = On Hold 

reference

normalizedString

Opportunity Reference

X

 

 

 

 

Reference for the Opportunity. 

name

normalizedString

Opportunity Name

 

X

 

 

 

Name of the Opportunity. 

description

normalizedString

Opportunity Description

 

X

 

 

 

A longer description of the Opportunity. 

companyReference

normalizedString

Opportunity Company Reference

 

X

 

 

 

Reference for the Opportunity as used by the Company.  

customerReference

normalizedString

Opportunity Customer Reference

 

X

 

 

 

Reference for the Opportunity as used by the Customer.  

customerTradingAccount

tradingAccount

Opportunity Customer TradingAccount

 

X

 

 

reference 

Link to the Opportunity Customer account (if available). See TradingAccount definition.  

tradingAccountReference

normalizedString

Opportunity Customer TradingAccount Reference

 

X

 

 

 

Reference for the Opportunity as used by the Customer Trading Account.  

commodities

commodity*

Opportunity Commodity

 

X

 

 

association 

Link to the Commodity used on the Opportunity if any. See Commodity definition. Not mandatory as Opportunity may be free text.  

text

string

Opportunity Commodity Text

 

X

 

 

 

Text applicable to the Opportunity (e.g. description of product or service the Opportunity is for).  

currency

normalizedString

Opportunity Currency

 

X

 

 

 

The currency of the Opportunity (e.g. GBP, USD, EUR). ISO 4217. Will be same as Trading Account, if available.  

operatingCompanyCurrency

normalizedString

Opportunity OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Opportunity OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Opportunity Currency into Opportunity OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Opportunity OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Opportunity Currency to Opportunity OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Opportunity Values in Opportunity Currency / Opportunity Operating Company Currency Exchange Rate = Opportunity Values in Opportunity OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Opportunity OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Opportunity Currency to Opportunity OperatingCompany Currency, if different. Default = System date  

contacts

contact*

Opportunity Contact

 

X

 

 

association 

Link to the Contact(s) associated with the Opportunity. See Contact definition.  

source

normalizedString

Opportunity Source

 

X

 

 

 

The source of the Opportunity, e.g. referral, advertisement etc.  

salesPersons

salesPerson*

Opportunity SalesPersons

 

X

 

 

association 

Sales person(s) associated with the Opportunity. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

date

date

Opportunity Date

 

X

 

 

 

The date the Opportunity was generated. 

closeDate

date

Opportunity Close Date

 

X

 

 

 

The date by which the Opportunity is expected to be closed (completed).  

openDays

normalizedString

Opportunity Open Days

 

X

 

 

 

Duration in days the Opportunity has been open (e.g. number of days since Opportunity Date).  

priority

opportunityPriority

Opportunity Priority

 

X

 

 

 

Priority of the Opportunity, e.g. High, Medium, Low  

probabilityIndicatorType

opportunityProbabilityIndicatorType

Opportunity Probability Indicator Type

 

X

 

 

 

Flag to indicate the type of indicator used to measure Opportunity probability/likelihood (percent or string).  

probabilityIndicatorString

normalizedString

Opportunity Probability Indicator String

 

X

 

 

 

Probability applicable to the Opportunity expressed as a string (e.g. high, medium, low).  

probabilityIndicatorPercent

decimal

Opportunity Probability Indicator Percent

 

X

 

 

 

Probability applicable to the Opportunity expressed as a percentage.  

workflowIndicator1

string

Opportunity Workflow Indicator1

 

X

 

 

 

To support Opportunity workflow. This attribute can be used to track, e.g. the position in the sales cycle.  

workflowIndicator2

string

Opportunity Workflow Indicator2

 

X

 

 

 

Additional attribute to support Opportunity workflow. This attribute can be used to track, e.g. the stage in the sales cycle.  

netTotal

decimal

Opportunity Net Total

 

X

 

 

 

Total forecast value of the Opportunity, including discounts, excluding tax. In opportunity currency.  

discountTotal

decimal

Opportunity Discount Total

 

X

 

 

 

Total forecast value of the discounts applied to the Opportunity. In opportunity currency.  

chargesTotal

decimal

Opportunity Charges Total

 

X

 

 

 

Total forecast value of any (sur)charges applied to the Opportunity (e.g. finance charges, interest). In opportunity currency.  

taxTotal

decimal

Opportunity Tax Total

 

X

 

 

 

Total forecast tax applicable to the Opportunity. In opportunity currency.  

grossTotal

decimal

Opportunity Gross Total

 

X

 

 

 

Total forecast value of the Opportunity, including tax & discounts & charges. In opportunity currency.  

costTotal

decimal

Opportunity Cost Total

 

X

 

 

 

Total forecast cost applicable to the Opportunity. In opportunity currency.  

profitTotal

decimal

Opportunity Profit Total

 

X

 

 

 

Total forecast profit applicable to the Opportunity. In opportunity currency.  

quotationNetTotal

decimal

Opportunity Quotation Net Total

 

X

 

 

 

Total actual value of the Quotation(s) associated with the Opportunity, including discounts, excluding tax. In opportunity currency. From associated Sales Quotations, if any.  

quotationDiscountTotal

decimal

Opportunity Quotation Discount Total

 

X

 

 

 

Total actual value of the discounts applied to the Quotation(s) associated with the Opportunity. In opportunity currency. From associated Sales Quotations, if any.  

quotationChargesTotal

decimal

Opportunity Quotation Charges Total

 

X

 

 

 

Total actual value of any (sur)charges applied to the Quotation(s) associated with the Opportunity (e.g. finance charges, interest). In opportunity currency. From associated Sales Quotations, if any.  

quotationTaxTotal

decimal

Opportunity Quotation Tax Total

 

X

 

 

 

Total actual tax applicable to the Quotation(s) associated with the Opportunity. In opportunity currency. From associated Sales Quotations, if any.  

quotationGrossTotal

decimal

Opportunity Quotation Gross Total

 

X

 

 

 

Total actual value of the Quotation(s) associated with the Opportunity, including tax & discounts & charges. In opportunity currency. From associated Sales Quotations, if any.  

quotationCostTotal

decimal

Opportunity Quotation Cost Total

 

X

 

 

 

Total actual cost of the Quotation(s) associated with the Opportunity. In opportunity currency. From associated Sales Quotations, if any.  

quotationProfitTotal

decimal

Opportunity Quotation Profit Total

 

X

 

 

 

Total actual profit of the Quotations(s) associated with the Opportunity. In opportunity currency. From associated Sales Quotations, if any.  

salesQuotations

salesQuotation*

Opportunity SalesQuotation

 

X

 

 

association 

A link to the Sales Quotation(s) raised against the Opportunity. See SalesQuotation definition. Must be in Opportunity currency.  

orderNetTotal

decimal

Opportunity Order Net Total

 

X

 

 

 

Total actual value of the Order(s) associated with the Opportunity, including discounts, excluding tax. In opportunity currency. From associated Sales Orders, if any.  

orderDiscountTotal

decimal

Opportunity Order Discount Total

 

X

 

 

 

Total actual value of the discounts applied to the Order(s) associated with the Opportunity. In opportunity currency. From associated Sales Orders, if any.  

orderChargesTotal

decimal

Opportunity Order Charges Total

 

X

 

 

 

Total actual value of any (sur)charges applied to the Order(s) associated with the Opportunity (e.g. finance charges, interest). In opportunity currency. From associated Sales Orders, if any.  

orderTaxTotal

decimal

Opportunity Order Tax Total

 

X

 

 

 

Total actual tax applicable to the Order(s) associated with the Opportunity. In opportunity currency. From associated Sales Orders, if any.  

orderGrossTotal

decimal

Opportunity Order Gross Total

 

X

 

 

 

Total actual value of the Order(s) associated with the Opportunity, including tax & discounts & charges. In opportunity currency. From associated Sales Orders, if any.  

orderCostTotal

decimal

Opportunity Order Cost Total

 

X

 

 

 

Total actual cost of the Order(s) associated with the Opportunity. In opportunity currency. From associated Sales Orders, if any.  

orderProfitTotal

decimal

Opportunity Order Profit Total

 

X

 

 

 

Total actual profit of the Order(s) associated with the Opportunity In opportunity currency. From associated Sales Orders, if any.  

salesOrders

salesOrder*

Opportunity SalesOrder

 

X

 

 

association 

A link to the Sales Order(s) raised against the Opportunity. See SalesOrder definition. Must be in Opportunity currency.  

interactions

interaction*

Opportunity Interactions

 

X

 

 

association 

Interaction(s) associated with the Opportunity (e.g. phone calls). See Interaction definition.  

privacyFlag

boolean

Opportunity Privacy Flag

 

 

 

 

 

Flag to indicate if the Opportunity is public or private. Default = No (not private).  

notes

note*

Opportunity Notes

 

X

 

 

child 

Notes associated with an Opportunity. See Note definition.  

Top  

Resource interaction

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Interaction Active Flag

 

 

 

 

 

Flag to indicate if the Interaction is an active one. Default = True  

type

interactionType

Interaction Type

 

 

 

X

 

The type of Interaction (e.g. meeting, to-do, phone call, email, letter, etc). Default = Unknown  

status

interactionStatus

Interaction Status

 

X

 

 

 

Status of the Interaction (e.g. complete, in-progress, etc).  

reference

normalizedString

Interaction Reference

X

 

 

 

 

Reference for the Interaction. 

name

normalizedString

Interaction Name

 

X

 

 

 

Name of the Interaction (regarding). 

subject

normalizedString

Interaction Subject

 

X

 

 

 

Subject of the Interaction. 

description

normalizedString

Interaction Description

 

 

 

X

 

A longer description of the Interaction. 

user

normalizedString

Interaction User

 

X

 

 

 

Link to the user involved in the Interaction. The user resource will be defined in the future.  

priority

interactionPriority

Interaction Priority

 

X

 

 

 

Priority of the Interaction, e.g. High, Medium, Low  

tradingAccount

tradingAccount

Interaction Customer Supplier TradingAccount

 

X

 

 

reference 

Link to the Interaction Customer or Supplier account (if available). See TradingAccount definition.  

salesInvoices

salesInvoice*

Interaction SalesInvoice

 

X

 

 

association 

Link to any Sales Invoices raised against the Interaction (e.g. if the Interaction is chargeable). See SalesInvoice definition.  

contacts

contact*

Interaction Contact

 

X

 

 

association 

Link to the Contact(s) associated with the Interaction. See Contact definition.  

commodities

commodity*

Interaction Commodity

 

X

 

 

association 

The Commodity associated with the Interaction, if any. See Commodity definition.  

date

date

Interaction Date

 

X

 

 

 

The date the Interaction was scheduled or took place.  

time

time

Interaction Time

 

X

 

 

 

The time the Interaction was scheduled or took place. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

endDate

date

Interaction End Date

 

X

 

 

 

The scheduled or actual end date of the Interaction.  

endTime

time

Interaction End Time

 

X

 

 

 

The scheduled or actual end time of the Interaction. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

duration

duration

Interaction Duration

 

X

 

 

 

The duration of the Interaction. 

expirationDate

date

Interaction Expiration Date

 

X

 

 

 

The expiration date of the Interaction. 

expirationTime

time

Interaction Expiration Time

 

X

 

 

 

The expiration end time of the Interaction. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

recurrence

boolean

Interaction Recurrence

 

X

 

 

 

A flag to indicate if the Interaction is recurring. Default is False.  

recurrenceFrequency

interactionRecurrenceFrequency

Interaction Recurrence Frequency

 

X

 

 

 

The frequency of the Interaction. 

workflowIndicator1

string

Interaction Workflow Indicator1

 

X

 

 

 

To support Interaction workflow. This attribute can be used to track, e.g. the position in the sales cycle.  

workflowIndicator2

string

Interaction Workflow Indicator2

 

X

 

 

 

Additional attribute to support Interaction workflow. This attribute can be used to track, e.g. the stage in the sales cycle.  

privacyFlag

boolean

Interaction Privacy Flag

 

 

 

 

 

Flag to indicate if the Interaction is public or private. Default = No (not private).  

project

project

Interaction Project

 

X

 

 

reference 

Identifier of the Project this Interaction is for. See Project definition.  

case

case

Interaction Case

 

X

 

 

reference 

Case(s) associated with the Interaction. See Case definition.  

notes

note*

Interaction Note

 

X

 

 

child 

Notes associated with an Interaction. 

receipt

receipt*

Interaction Receipt

 

 

 

 

association 

Link to the Receipt(s) this Interactions is for (e.g. for recurring receipts, or if the sale invoice associated with this interaction has been paid.   See “Receipt” definition.  

payment

payment*

Interaction Payment

 

 

 

 

association 

Link to the Payment(s) this Interactions is for (e.g. for recurring payments.   See “Payment” definition.  

recurrenceNumber

decimal

Interaction Recurrence Number

 

 

 

 

 

For interactions that are recurring, this is the Number of recurrences (e.g. 3), relative to recurrenceFrequency. 

interaction

interaction*

Interaction Interaction(s)

 

 

 

 

association 

Link to other interactions associated with this interaction (e.g. for scheduled/repeating interactions or for past recurring receipts/payments). 

businessDayOverrideFlag

businessDayOverrideFlag

Interaction Business Day Override Flag

 

 

 

 

 

Flag to indicate what happens if this occurrence of an interaction is scheduled for a non-business day. Options are "None" (schedule for non-business day), "Before" or "After" (indicating use business day before or after.  

reference2

string

Interaction Reference2

 

 

 

 

 

second reference for the Interaction.    

recurrenceType

string

Interaction Recurrence Type

 

 

 

 

 

For interactions that are recurring, this is the type of recurrence. 

Top  

Resource salesInvoice

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesInvoice Active Flag

 

 

 

 

 

Flag to indicate if the Sales Invoice is an active one. Default = True  

reference

normalizedString

SalesInvoice Reference

X

 

 

 

 

Reference for the Sales Invoice. 

reference2

normalizedString

SalesInvoice Reference2

 

X

 

 

 

Additional reference for the Sales Invoice. 

status

salesInvoiceStatus

SalesInvoice Status

 

X

 

 

 

Status of the Sales Invoice 

allocationStatus

salesInvoiceAllocationStatus

SalesInvoice Allocation Status

 

X

 

 

 

Status of Commodity allocations against the Invoice.  

deliveryStatus

salesInvoiceDeliveryStatus

SalesInvoice Delivery Status

 

X

 

 

 

Delivery status of the Invoice. 

statusFlag

boolean

SalesInvoice Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Invoice on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

SalesInvoice Status Flag Text

 

X

 

 

 

Sales Invoice status flag text. Default = On Hold  

type

salesInvoiceType

SalesInvoice Type

 

X

 

 

 

Type of Sales Invoice (e.g. pro-forma, etc) 

tradingAccount

tradingAccount

SalesInvoice Customer TradingAccount

 

 

 

 

reference 

Link to the Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesInvoice Customer Reference

 

X

 

 

 

Customer/debtors own reference for the Sales Invoice (e.g. PO number).  

opportunity

opportunity

SalesInvoice Opportunity

 

X

 

 

reference 

Opportunity linked to the Sales Invoice (if any). See Opportunity definition.  

pricelist

priceList

SalesInvoice PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Sales Invoice. See PriceList definition.  

copyFlag

boolean

SalesInvoice Copy Flag

 

 

 

 

 

Indicates if this Sales Invoice is a copy or not. Default is false (no)  

date

date

SalesInvoice Date

 

 

 

 

 

Date the Sales Invoice was raised. 

time

time

SalesInvoice Time

 

X

 

 

 

Time the Sales Invoice was raised. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

taxDate

date

SalesInvoice Tax Date

 

 

 

 

 

Used to indicate the point at which tax becomes applicable. Can default to Invoice date.  

taxCodes

taxCode*

SalesInvoice Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Invoice. See TaxCode definition.  

postalAddresses

postalAddress*

SalesInvoice PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Invoice. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

SalesInvoice Delivery Method

 

X

 

 

 

Delivery method to be employed for the Sales Invoice (e.g. Courier, Collection, etc)  

deliveryTerms

normalizedString

SalesInvoice Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryRule

boolean

SalesInvoice Delivery Rule

 

X

 

 

 

Flag to indicate if the Invoice has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryDate

date

SalesInvoice Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

SalesInvoice Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Sales Invoice. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

SalesInvoice Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Invoice. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesInvoice Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Invoice currency.  

carrierTaxPrice

decimal

SalesInvoice Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Invoice currency.  

carrierTotalPrice

decimal

SalesInvoice Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Invoice currency.  

carrierSalesInvoices

salesInvoice*

SalesInvoice Carrier SalesInvoices

 

X

 

 

association 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoices

purchaseInvoice*

SalesInvoice Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesInvoice Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Invoice. See TaxCode definition.  

carrierReference

normalizedString

SalesInvoice Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

SalesInvoice Currency

 

 

 

 

 

The currency (e.g. GBP, USD, EUR) used on the Sales Invoice. ISO 4217.  

operatingCompanyCurrency

normalizedString

SalesInvoice OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesInvoice OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Invoice Currency into Sales Invoice OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesInvoice OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Invoice Currency to Sales Invoice OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Invoice Values in Sales Invoice Currency / Sales Invoice Operating Company Currency Exchange Rate = Sales Invoice Values in Sales Invoice OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesInvoice OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Invoice Currency to Sales Invoice OperatingCompany Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesInvoice Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Sales Invoice. ISO 4217. Could be same as Invoice currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesInvoice Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Invoice currency into the Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesInvoice Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Invoice Currency to Sales Invoice Customer Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Invoice Values in Sales Invoice Currency / Sales Invoice Customer TradingAccount Currency Exchange Rate = Sales Invoice Values in Sales Invoice Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesInvoice Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Invoice Currency to Trading Account Currency, if different. Default = System date  

buyerContact

contact

SalesInvoice Buyer Contact

 

X

 

 

reference 

Link to the Contact at Customer who the Sales Invoice is for. See Contact definition.  

salesPersons

salesPerson*

SalesInvoice SalesPersons

 

X

 

 

association 

Sales person associated with the Sales Invoice. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

salesInvoiceLines

salesInvoiceLine*

SalesInvoice SalesInvoiceLine

 

 

 

 

child 

Sales Invoice Line detail. See SalesInvoiceLine definition.  

lineCount

decimal

SalesInvoice Line Count

 

 

 

 

 

The number of lines on the Sales Invoice. Should be auto-populated. Used as a cross reference to ensure Invoice integrity.  

originatorDocuments

salesInvoiceOriginatorDocument*

SalesInvoice Originator Document References

 

X

 

 

association 

Reference to other documents (e.g. the sales order associated with the Invoice). Could also include a link to the original Sales Invoice if an Invoice is cancelled (reversed).  

salesOrderDeliveries

salesOrderDelivery*

SalesInvoice SalesOrderDelivery

 

X

 

 

association 

A link to the Sales Order Delivery associated with this Invoice. See SalesOrderDelivery definition.  

receipts

receipt*

SalesInvoice Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Sales Invoice See Receipt definition.  

contract

string

SalesInvoice Contract

 

X

 

 

 

Reference to a contract associated with the Sales Invoice. If Contracts aren't used there may be an estimate instead - this would contain the reference of the estimate.  

settlementDiscountType

discountType

SalesInvoice Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Sales Invoice (percent or amount). From the Trading Account.  

settlementDiscountAmount

decimal

SalesInvoice Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Sales Invoice if the Sales Invoice is paid within a certain timeframe, expressed as an amount. From the Trading Account.  

settlementDiscountPercent

decimal

SalesInvoice Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Sales Invoice if the Sales Invoice is paid within a certain timeframe, expressed as a percentage. From the Trading Account.  

settlementDiscountTerms

normalizedString

SalesInvoice Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Trading Account.  

settlementDiscountIncludedInTotal

boolean

SalesInvoice Settlement Discount Included In Total

 

X

 

 

 

Flag to indicate if settlement discount is included in Invoice Totals Default = False  

invoiceDiscountType

discountType

SalesInvoice Invoice Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Sales Invoice (percent or amount). From the Trading Account.  

invoiceDiscountAmount

decimal

SalesInvoice Invoice Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Sales Invoice, expressed as an amount. From the Trading Account.  

invoiceDiscountPercent

decimal

SalesInvoice Invoice Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Sales Invoice, expressed as a percentage. From the Trading Account.  

invoiceAdditionalDiscount1Type

discountType

SalesInvoice Invoice Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Invoice (percent or amount)  

invoiceAdditionalDiscount1Amount

decimal

SalesInvoice Invoice Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Sales Invoice expressed as an amount.  

invoiceAdditionalDiscount1Percent

decimal

SalesInvoice Invoice Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Sales Invoice expressed as a percent.  

invoiceAdditionalDiscount2Type

discountType

SalesInvoice Invoice Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Invoice (percent or amount)  

invoiceAdditionalDiscount2Amount

decimal

SalesInvoice Invoice Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Sales Invoice expressed as an amount.  

invoiceAdditionalDiscount2Percent

decimal

SalesInvoice Invoice Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Sales Invoice expressed as a percent.  

netTotal

decimal

SalesInvoice Net Total

 

 

 

 

 

Total value of the Sales Invoice, including discounts, excluding tax. In Sales Invoice currency.  

discountTotal

decimal

SalesInvoice Discount Total

 

 

 

 

 

Total discounts applied to the Sales Invoice. In Sales Invoice currency.  

chargesTotal

decimal

SalesInvoice Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Invoice (e.g. finance charges, interest). In Sales Invoice currency.  

taxTotal

decimal

SalesInvoice Tax Total

 

 

 

 

 

Total tax applicable to the Sales Invoice. In Sales Invoice currency.  

grossTotal

decimal

SalesInvoice Gross Total

 

 

 

 

 

Total value of the Sales Invoice, including tax & discounts & charges. In Sales Invoice currency.  

costTotal

decimal

SalesInvoice Cost Total

 

X

 

 

 

Total cost of the Sales Invoice. In Sales Invoice currency.  

profitTotal

decimal

SalesInvoice Profit Total

 

X

 

 

 

Total profit on the Sales Invoice (e.g. net total - cost total). In Sales Invoice currency.  

text1

string

SalesInvoice Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Invoice. Header text  

text2

string

SalesInvoice Text2

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Invoice. Footer text  

projects

project*

SalesInvoice Project

 

X

 

 

association 

Identifier of the Project this Sales Invoice is for. See Project definition.  

projectLines

projectLine*

SalesInvoice ProjectLine

 

X

 

 

association 

Project Line value for this Sales Invoice. See Project Line definition. Some applications may not have Project Lines.  

cases

case*

SalesInvoice Cases

 

X

 

 

association 

The reference of the case associated with the Sales Invoice, e.g. if the Invoice is for repair/fix services. A Case entity has been defined to support the F2F process.  

financialAccounts

financialAccount*

SalesInvoice FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Invoice. See FinancialAccount definition.  

costCentres

costCentre*

SalesInvoice CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Invoice. See Cost Centre definition.  

departments

department*

SalesInvoice Departments

 

X

 

 

association 

Department(s) associated with this Sales Invoice. See Department definition.  

interactions

interaction*

SalesInvoice Interactions

 

X

 

 

association 

Interaction(s) associated with the Sales Invoice. See Interaction definition.  

user

normalizedString

SalesInvoice User

 

X

 

 

 

Link to the user who generated the Sales Invoice. The user resource will be defined in the future.  

notes

note*

SalesInvoice Note

 

X

 

 

child 

Notes associated with a Sales Invoice (e.g. credit control).  

Top  

Resource salesInvoiceLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesInvoice

salesInvoice

SalesInvoiceLine Sales Invoice

 

 

 

 

parent 

The parent SalesInvoice 

originatorDocumentLines

salesInvoiceLineOriginatorDocumentLine*

SalesInvoiceLine Originator Document Line References

 

X

 

 

association 

Reference to Lines on another document (e.g. the sales order Line or bill Line associated with the Invoice Line). Sales Invoice Lines are often associated with Sales Order Lines. Could also include a link to the original Invoice Line if an Invoice is cancelled (reversed).  

active

boolean

SalesInvoiceLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Invoice Line is an active one. Default = True  

reference

normalizedString

SalesInvoiceLine Reference

X

 

 

 

 

Reference for the Sales Invoice. 

reference2

normalizedString

SalesInvoiceLine Reference2

 

X

 

 

 

Additional reference for the Sales Invoice. 

status

salesInvoiceStatus

SalesInvoiceLine Status

 

X

 

 

 

Status of the Sales Invoice Line. 

type

lineType

SalesInvoiceLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Invoice Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

number

decimal

SalesInvoiceLine Number

 

 

 

 

 

The number of the Sales Invoice Line. For sequencing and ordering of lines.  

commodity

commodity

SalesInvoiceLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Invoice Line (if any). See Commodity definition.  

text

string

SalesInvoiceLine Text

 

X

 

 

 

Text applicable to the Sales Invoice Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Invoice Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesInvoiceLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Sales Invoice Line. See Variant definition.  

commodityDimension

commodityDimension

SalesInvoiceLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the Sales Invoice Line. See Dimension definition.  

commodityIdentifier

commodityIdentifier

SalesInvoiceLine Commodity Identifier

 

X

 

 

reference 

Link to the Commodity Identifier(s) for this Sales Invoice Line, if it is traced to that level of detail.  

deliveryTerms

normalizedString

SalesInvoiceLine Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

SalesInvoiceLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierTradingAccount

tradingAccount

SalesInvoiceLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Invoice Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesInvoiceLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Invoice currency.  

carrierTaxPrice

decimal

SalesInvoiceLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Invoice currency.  

carrierTotalPrice

decimal

SalesInvoiceLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Invoice currency.  

carrierSalesInvoiceLine

salesInvoiceLine

SalesInvoiceLine Carrier SalesInvoiceLine

 

X

 

 

reference 

A link to the Sales Invoice Line generated to recharge the carriage to the Customer. See SalesInvoiceLine definition.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

SalesInvoiceLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoiceLine definition.  

carrierTaxCodes

taxCode*

SalesInvoiceLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Invoice Line. See TaxCode definition.  

carrierReference

normalizedString

SalesInvoiceLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

unitOfMeasure

unitOfMeasure

SalesInvoiceLine UnitOfMeasure

 

X

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

SalesInvoiceLine Quantity

 

 

 

X

 

The quantity of the Sales Invoice Line. Default to 1 if not used.  

initialPrice

decimal

SalesInvoiceLine Initial Price

 

X

 

 

 

The initial price of the Sales Invoice Line (e.g. before discounts). In Sales Invoice currency.  

pricelist

priceList

SalesInvoiceLine PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Sales Invoice Line. See PriceList definition.  

settlementDiscountType

discountType

SalesInvoiceLine Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Sales Invoice Line (percent or amount). From the Sales Invoice.  

settlementDiscountAmount

decimal

SalesInvoiceLine Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Sales Invoice Line if the Sales Invoice is paid within a certain timeframe, expressed as an amount. From the Sales Invoice.  

settlementDiscountPercent

decimal

SalesInvoiceLine Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Sales Invoice Line if the Sales Invoice is paid within a certain timeframe, expressed as a percentage. From the Sales Invoice.  

settlementDiscountTerms

normalizedString

SalesInvoiceLine Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Sales Invoice.  

invoiceLineDiscountType

discountType

SalesInvoiceLine Invoice Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Sales Invoice Line (percent or amount)  

invoiceLineDiscountAmount

decimal

SalesInvoiceLine Invoice Line Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Sales Invoice Line, expressed as an amount.  

invoiceLineDiscountPercent

decimal

SalesInvoiceLine Invoice Line Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Sales Invoice Line, expressed as a percentage.  

invoiceLineSubtotalDiscountType

discountType

SalesInvoiceLine Invoice Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Invoice Lines (percent or amount) of which this Line is part.  

invoiceLineSubtotalDiscountAmount

decimal

SalesInvoiceLine Invoice Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Invoice Line, expressed as an amount.  

invoiceLineSubtotalDiscountPercent

decimal

SalesInvoiceLine Invoice Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Invoice Line, expressed as a percentage.  

actualPrice

decimal

SalesInvoiceLine Actual Price

 

X

 

 

 

The actual price of the Sales Invoice Line (e.g. after discounts or adjustments). In Sales Invoice currency.  

netTotal

decimal

SalesInvoiceLine Net Total

 

 

 

 

 

Total value of the Sales Invoice Line, including discounts, excluding tax (e.g. quantity * actual price). In Sales Invoice currency. Could be calculated.  

chargesTotal

decimal

SalesInvoiceLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Invoice Line (e.g. finance charges, interest). In Sales Invoice currency.  

discountTotal

decimal

SalesInvoiceLine Discount Total

 

 

 

 

 

Total discounts applied to the invoice line. In Sales Invoice currency.  

fobPoint

string

SalesInvoiceLine FOB Point

 

X

 

 

 

The FOB point applicable to the Sales Invoice Line. FOB is an abbreviation for Free On Board. The term FOB is used when shipping goods, to indicate who pays loading and transportation costs, and/or the point at which the responsibility of the goods transfers from shipper to buyer  

taxCodes

taxCode*

SalesInvoiceLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Invoice Line. See TaxCode definition.  

priceTax

decimal

SalesInvoiceLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Invoice Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesInvoiceLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Invoice Line. In order currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesInvoiceLine Gross Total

 

 

 

 

 

Total value of the Sales Invoice Line, including discounts & tax & charges. In Sales Invoice currency.  

costTotal

decimal

SalesInvoiceLine Cost Total

 

X

 

 

 

Total cost of the Sales Invoice Line. In Sales Invoice currency.  

profitTotal

decimal

SalesInvoiceLine Profit Total

 

X

 

 

 

Total profit on the Sales Invoice Line (e.g. net total - cost total). In Sales Invoice currency.  

project

project

SalesInvoiceLine Project

 

X

 

 

reference 

Identifier of the Project this Sales Invoice Line is for (if any). See Project definition.  

projectLine

projectLine

SalesInvoiceLine ProjectLine

 

X

 

 

reference 

Project Line value for this Sales Invoice Line. See Project Line definition. Some applications may not have Project Lines.  

salesOrderDeliveryLines

salesOrderDeliveryLine*

SalesInvoiceLine Delivery Line

 

X

 

 

association 

Link to the Delivery (dispatch) Line associated with the Sales Invoice Line. See SalesOrderDeliveryLine definition.  

receipts

receipt*

SalesInvoiceLine Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Sales Invoice Line See Receipt definition.  

receiptLines

receiptLine*

SalesInvoiceLine ReceiptLine

 

X

 

 

association 

A link to the (cash) receipt line(s) associated with this Sales Invoice Line. See ReceiptLine definition.  

financialAccounts

financialAccount*

SalesInvoiceLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Invoice Line. See FinancialAccount definition.  

costCentres

costCentre*

SalesInvoiceLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Invoice Line. See Cost Centre definition.  

departments

department*

SalesInvoiceLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Invoice Line. See Department definition.  

notes

note*

SalesInvoiceLine Note

 

X

 

 

child 

Notes associated with a Sales Invoice Line (e.g. for credit control).  

Top  

Resource salesCredit

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesCredit Active Flag

 

 

 

 

 

Flag to indicate if the Sales Credit is an active one. Default = True  

reference

normalizedString

SalesCredit Reference

X

 

 

 

 

Reference for the Sales Credit. 

reference2

normalizedString

SalesCredit Reference2

 

X

 

 

 

Additional reference for the Sales Credit. 

status

salesCreditStatus

SalesCredit Status

 

X

 

 

 

Status of the Sales Credit 

statusFlag

boolean

SalesCredit Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Credit on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

SalesCredit Status Flag Text

 

X

 

 

 

Sales Credit status flag text. Default = On Hold  

type

salesCreditType

SalesCredit Type

 

X

 

 

 

Type of Sales Credit (e.g. pro-forma, etc) 

tradingAccount

tradingAccount

SalesCredit Customer TradingAccount

 

 

 

 

reference 

Link to the Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesCredit Customer Reference

 

X

 

 

 

Customer/debtors own reference for the Sales Credit (e.g. PO number).  

opportunity

opportunity

SalesCredit Opportunity

 

X

 

 

reference 

Opportunity linked to the Sales Credit (if any). See Opportunity definition.  

pricelist

priceList

SalesCredit PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Sales Credit. See PriceList definition.  

copyFlag

boolean

SalesCredit Copy Flag

 

 

 

 

 

Indicates if this Sales Credit is a copy or not. Default is false (no)  

date

date

SalesCredit Date

 

 

 

 

 

Date the Sales Credit was raised. 

time

time

SalesCredit Time

 

X

 

 

 

Time the Sales Credit was raised. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

taxDate

date

SalesCredit Tax Date

 

 

 

 

 

Used to indicate the point at which tax becomes applicable. Can default to Invoice date.  

taxCodes

taxCode*

SalesCredit Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Credit. See TaxCode definition.  

postalAddresses

postalAddress*

SalesCredit PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Credit. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

SalesCredit Delivery Method

 

X

 

 

 

Delivery method to be employed for the Sales Credit (e.g. Courier, Collection, etc)  

deliveryTerms

normalizedString

SalesCredit Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryRule

boolean

SalesCredit Delivery Rule

 

X

 

 

 

Flag to indicate if the Invoice has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryDate

date

SalesCredit Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

SalesCredit Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Sales Credit. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

SalesCredit Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Credit. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesCredit Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Invoice currency.  

carrierTaxPrice

decimal

SalesCredit Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Invoice currency.  

carrierTotalPrice

decimal

SalesCredit Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Invoice currency.  

carrierSalesInvoices

salesInvoice*

SalesCredit Carrier SalesInvoices

 

X

 

 

association 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoices

purchaseInvoice*

SalesCredit Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesCredit Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Credit. See TaxCode definition.  

carrierReference

normalizedString

SalesCredit Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

SalesCredit Currency

 

 

 

 

 

The currency (e.g. GBP, USD, EUR) used on the Sales Credit. ISO 4217.  

operatingCompanyCurrency

normalizedString

SalesCredit OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesCredit OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Credit Currency into Sales Credit OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesCredit OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Credit Currency to Sales Credit OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Credit Values in Sales Credit Currency / Sales Credit Operating Company Currency Exchange Rate = Sales Credit Values in Sales Credit OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesCredit OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Credit Currency to Sales Credit OperatingCompany Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesCredit Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Sales Credit. ISO 4217. Could be same as Invoice currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesCredit Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Credit currency into the Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesCredit Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Credit Currency to Sales Credit Customer Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Credit Values in Sales Credit Currency / Sales Credit Customer TradingAccount Currency Exchange Rate = Sales Credit Values in Sales Credit Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesCredit Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Credit Currency to Trading Account Currency, if different. Default = System date  

buyerContact

contact

SalesCredit Buyer Contact

 

X

 

 

reference 

Link to the Contact at Customer who the Sales Credit is for. See Contact definition.  

salesPersons

salesPerson*

SalesCredit SalesPersons

 

X

 

 

association 

Sales person associated with the Sales Credit. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

salesCreditLines

salesCreditLine*

SalesCredit SalesCreditLine

 

 

 

 

child 

Sales Credit Line detail. See SalesCreditLine definition.  

lineCount

decimal

SalesCredit Line Count

 

 

 

 

 

The number of lines on the Sales Credit. Should be auto-populated. Used as a cross reference to ensure Invoice integrity.  

originatorDocuments

salesCreditOriginatorDocument*

SalesCredit Originator Document References

 

X

 

 

association 

Reference to other documents (e.g. the Sales Invoice associated with the sales credit). Could also include a link to the original Sales Credit if a credit is cancelled (reversed).  

salesReturnDeliveries

salesReturnDelivery*

SalesCredit SalesReturnDelivery

 

X

 

 

association 

A link to the Sales Return Delivery associated with this Invoice. See SalesReturnDelivery definition.  

payments

payment*

SalesCredit Payment

 

X

 

 

association 

A link to the (cash) payment(s) associated with this Sales Credit. See Payment definition.  

contract

string

SalesCredit Contract

 

X

 

 

 

Reference to a contract associated with the Sales Credit.  

settlementDiscountType

discountType

SalesCredit Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Sales Credit (percent or amount). From the Trading Account.  

settlementDiscountAmount

decimal

SalesCredit Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Sales Credit if the Sales Credit is paid within a certain timeframe, expressed as an amount. From the Trading Account.  

settlementDiscountPercent

decimal

SalesCredit Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Sales Credit if the Sales Credit is paid within a certain timeframe, expressed as a percentage. From the Trading Account.  

settlementDiscountTerms

normalizedString

SalesCredit Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Trading Account.  

settlementDiscountIncludedInTotal

boolean

SalesCredit Settlement Discount Included In Total

 

X

 

 

 

Flag to indicate if settlement discount is included in Invoice Totals Default = False  

invoiceDiscountType

discountType

SalesCredit Invoice Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Sales Credit (percent or amount). From the Trading Account.  

invoiceDiscountAmount

decimal

SalesCredit Invoice Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Sales Credit, expressed as an amount. From the Trading Account.  

invoiceDiscountPercent

decimal

SalesCredit Invoice Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Sales Credit, expressed as a percentage. From the Trading Account.  

invoiceAdditionalDiscount1Type

discountType

SalesCredit Invoice Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Credit (percent or amount)  

invoiceAdditionalDiscount1Amount

decimal

SalesCredit Invoice Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Sales Credit expressed as an amount.  

invoiceAdditionalDiscount1Percent

decimal

SalesCredit Invoice Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Sales Credit expressed as a percent.  

invoiceAdditionalDiscount2Type

discountType

SalesCredit Invoice Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Credit (percent or amount)  

invoiceAdditionalDiscount2Amount

decimal

SalesCredit Invoice Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Sales Credit expressed as an amount.  

invoiceAdditionalDiscount2Percent

decimal

SalesCredit Invoice Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Sales Credit expressed as a percent.  

netTotal

decimal

SalesCredit Net Total

 

 

 

 

 

Total value of the Sales Credit, including discounts, excluding tax. In Sales Credit currency.  

discountTotal

decimal

SalesCredit Discount Total

 

 

 

 

 

Total discounts applied to the Sales Credit. In Sales Credit currency.  

chargesTotal

decimal

SalesCredit Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Credit (e.g. finance charges, interest). In Sales Credit currency.  

taxTotal

decimal

SalesCredit Tax Total

 

 

 

 

 

Total tax applicable to the Sales Credit. In Sales Credit currency.  

grossTotal

decimal

SalesCredit Gross Total

 

 

 

 

 

Total value of the Sales Credit, including tax & discounts & charges. In Sales Credit currency.  

costTotal

decimal

SalesCredit Cost Total

 

X

 

 

 

Total cost of the Sales Credit. In Sales Credit currency.  

text1

string

SalesCredit Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Credit. Header text  

text2

string

SalesCredit Text2

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Credit. Footer text  

projects

project*

SalesCredit Project

 

X

 

 

association 

Identifier of the Project this Sales Credit is for. See Project definition.  

projectLines

projectLine*

SalesCredit ProjectLine

 

X

 

 

association 

Project Line value for this Sales Credit. See Project Line definition. Some applications may not have Project Lines.  

cases

case*

SalesCredit Cases

 

X

 

 

association 

The reference of the case associated with the Sales Credit, e.g. if the Credit is for repair/fix services. A Case entity has been defined to support the F2F process.  

financialAccounts

financialAccount*

SalesCredit FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Credit. See FinancialAccount definition.  

costCentres

costCentre*

SalesCredit CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Credit. See Cost Centre definition.  

departments

department*

SalesCredit Departments

 

X

 

 

association 

Department(s) associated with this Sales Credit. See Department definition.  

interactions

interaction*

SalesCredit Interactions

 

X

 

 

association 

Interaction(s) associated with the Sales Credit. See Interaction definition.  

user

normalizedString

SalesCredit User

 

X

 

 

 

Link to the user who generated the Sales Credit. The user resource will be defined in the future.  

notes

note*

SalesCredit Note

 

X

 

 

child 

Notes associated with a Sales Credit (e.g. credit control).  

Top  

Resource salesCreditLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesCredit

salesCredit

SalesCreditLine Sales Credit

 

 

 

 

parent 

The parent SalesCredit 

originatorDocumentLines

salesCreditLineOriginatorDocumentLine*

SalesCreditLine Originator Document Line References

 

X

 

 

association 

Reference to Lines on another document (e.g. the sales order Line or bill Line associated with the Invoice Line). Sales Credit Lines are often associated with Sales Order Lines. Could also include a link to the original Invoice Line if an Invoice is cancelled (reversed).  

active

boolean

SalesCreditLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Credit Line is an active one. Default = True  

reference

normalizedString

SalesCreditLine Reference

X

 

 

 

 

Reference for the Sales Credit. 

reference2

normalizedString

SalesCreditLine Reference2

 

X

 

 

 

Additional reference for the Sales Credit. 

status

normalizedString

SalesCreditLine Status

 

X

 

 

 

Status of the Sales Credit Line. 

type

lineType

SalesCreditLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Credit Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

number

decimal

SalesCreditLine Number

 

 

 

 

 

The number of the Sales Credit Line. For sequencing and ordering of lines.  

commodity

commodity

SalesCreditLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Credit Line (if any). See Commodity definition.  

text

string

SalesCreditLine Text

 

X

 

 

 

Text applicable to the Sales Credit Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Credit Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesCreditLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Sales Credit Line. See Variant definition.  

commodityDimension

commodityDimension

SalesCreditLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the Sales Credit Line. See Dimension definition.  

deliveryTerms

normalizedString

SalesCreditLine Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

SalesCreditLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierTradingAccount

tradingAccount

SalesCreditLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Credit Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesCreditLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Invoice currency.  

carrierTaxPrice

decimal

SalesCreditLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Invoice currency.  

carrierTotalPrice

decimal

SalesCreditLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Invoice currency.  

carrierSalesInvoiceLine

salesInvoiceLine

SalesCreditLine Carrier SalesInvoiceLine

 

X

 

 

reference 

A link to the Sales Invoice Line generated to recharge the carriage to the Customer. See SalesInvoiceLine definition.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

SalesCreditLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoiceLine definition.  

carrierTaxCodes

taxCode*

SalesCreditLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Credit Line. See TaxCode definition.  

carrierReference

normalizedString

SalesCreditLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

unitOfMeasure

unitOfMeasure

SalesCreditLine UnitOfMeasure

 

X

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

SalesCreditLine Quantity

 

 

 

X

 

The quantity of the Sales Credit Line. Default to 1 if not used.  

initialPrice

decimal

SalesCreditLine Initial Price

 

X

 

 

 

The initial price of the Sales Credit Line (e.g. before discounts). In Sales Credit currency.  

pricelist

priceList

SalesCreditLine PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Sales Credit Line. See PriceList definition.  

settlementDiscountType

discountType

SalesCreditLine Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Sales Credit Line (percent or amount). From the Sales Credit.  

settlementDiscountAmount

decimal

SalesCreditLine Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Sales Credit Line if the Sales Credit is paid within a certain timeframe, expressed as an amount. From the Sales Credit.  

settlementDiscountPercent

decimal

SalesCreditLine Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Sales Credit Line if the Sales Credit is paid within a certain timeframe, expressed as a percentage. From the Sales Credit.  

settlementDiscountTerms

normalizedString

SalesCreditLine Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Sales Credit.  

invoiceLineDiscountType

discountType

SalesCreditLine Invoice Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Sales Credit Line (percent or amount)  

invoiceLineDiscountAmount

decimal

SalesCreditLine Invoice Line Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Sales Credit Line, expressed as an amount.  

invoiceLineDiscountPercent

decimal

SalesCreditLine Invoice Line Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Sales Credit Line, expressed as a percentage.  

invoiceLineSubtotalDiscountType

discountType

SalesCreditLine Invoice Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Credit Lines (percent or amount) of which this Line is part.  

invoiceLineSubtotalDiscountAmount

decimal

SalesCreditLine Invoice Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Credit Line, expressed as an amount.  

invoiceLineSubtotalDiscountPercent

decimal

SalesCreditLine Invoice Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Credit Line, expressed as a percentage.  

actualPrice

decimal

SalesCreditLine Actual Price

 

X

 

 

 

The actual price of the Sales Credit Line (e.g. after discounts or adjustments). In Sales Credit currency.  

netTotal

decimal

SalesCreditLine Net Total

 

 

 

 

 

Total value of the Sales Credit Line, including discounts, excluding tax (e.g. quantity * actual price). In Sales Credit currency. Could be calculated.  

chargesTotal

decimal

SalesCreditLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Credit Line (e.g. finance charges, interest). In Sales Credit currency.  

discountTotal

decimal

SalesCreditLine Discount Total

 

 

 

 

 

Total discounts applied to the credit line. In Sales Credit currency.  

taxCodes

taxCode*

SalesCreditLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Credit Line. See TaxCode definition.  

priceTax

decimal

SalesCreditLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Credit Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesCreditLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Credit Line. In order currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesCreditLine Gross Total

 

 

 

 

 

Total value of the Sales Credit Line, including discounts & tax & charges. In Sales Credit currency.  

costTotal

decimal

SalesCreditLine Cost Total

 

X

 

 

 

Total cost of the Sales Credit Line. In Sales Credit currency.  

project

project

SalesCreditLine Project

 

X

 

 

reference 

Identifier of the Project this Sales Credit Line is for (if any). See Project definition.  

projectLine

projectLine

SalesCreditLine ProjectLine

 

X

 

 

reference 

Project Line value for this Sales Credit Line. See Project Line definition. Some applications may not have Project Lines.  

salesOrderDeliveryLines

salesReturnDeliveryLine*

SalesCreditLine Delivery Line

 

X

 

 

association 

Link to the Delivery (dispatch) Line associated with the Sales Credit Line. See SalesOrderDeliveryLine definition.  

payments

payment*

SalesCreditLine Payment

 

X

 

 

association 

A link to the (cash) payment(s) associated with this Sales Credit Line See Payment definition.  

paymentLines

paymentLine*

SalesCreditLine PaymentLine

 

X

 

 

association 

A link to the (cash) payment line(s) associated with this Sales Credit Line. See PaymentLine definition.  

financialAccounts

financialAccount*

SalesCreditLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Credit Line. See FinancialAccount definition.  

costCentres

costCentre*

SalesCreditLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Credit Line. See Cost Centre definition.  

departments

department*

SalesCreditLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Credit Line. See Department definition.  

notes

note*

SalesCreditLine Note

 

X

 

 

child 

Notes associated with a Sales Credit Line (e.g. for credit control).  

Top  

Resource salesReturn

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesReturn Active Flag

 

 

 

 

 

Flag to indicate if the Sales Return is an active one. Default = True  

reference

normalizedString

SalesReturn Reference

X

 

 

 

 

Reference for the Sales Return. 

reference2

normalizedString

SalesReturn Reference2

 

X

 

 

 

Additional reference for the Sales Return. 

status

salesReturnStatus

SalesReturn Status

 

X

 

 

 

Status of the Sales Return (e.g. Live, Completed).  

statusFlag

boolean

SalesReturn Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Return on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

SalesReturn Status Flag Text

 

X

 

 

 

Sales return Status Flag text. Default = On Hold  

tradingAccount

tradingAccount

SalesReturn Customer TradingAccount

 

 

 

 

reference 

Link to the Sales Return Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesReturn Customer Reference

 

X

 

 

 

Customer own reference for the Sales Return (e.g. a PO number).  

reason

string

SalesReturn Reason

 

X

 

 

 

The reason for the Sales Return. 

pricelist

priceList

SalesReturn PriceList

 

X

 

 

reference 

Link to the Price List used when generating the Sales Return. See PriceList definition.  

supplierTradingAccount

tradingAccount

SalesReturn Supplier TradingAccount

 

X

 

 

reference 

Link to the Sales Return Supplier account (e.g. for direct returns to Supplier). See TradingAccount definition.  

supplierReference

normalizedString

SalesReturn Supplier Reference

 

X

 

 

 

Supplier own reference for the Sales Return. 

type

normalizedString

SalesReturn Type

 

X

 

 

 

The Sales Return type. 

copyFlag

boolean

SalesReturn Copy Flag

 

 

 

 

 

Indicates if this Sales Return is a copy or not. Default is false (no)  

originatorDocuments

salesReturnOriginatorDocument*

SalesReturn Originator Document References

 

X

 

 

association 

Reference to other Sales Returns if required (e.g. if Return is a copy, then this will show which Return was copied, if return is for a Sales Order, this will show which Sales Order was returned).  

postalAddresses

postalAddress*

SalesReturn PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Sales Return. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

SalesReturn Delivery Method

 

X

 

 

 

Delivery method to be employed for Sales Return (e.g. Courier, Collection, etc)  

deliveryTerms

normalizedString

SalesReturn Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

SalesReturn Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

SalesReturn Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Sales Return. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

SalesReturn Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Return. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesReturn Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Return currency.  

carrierTaxPrice

decimal

SalesReturn Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Return currency. 

carrierTotalPrice

decimal

SalesReturn Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Return currency.  

carrierSalesInvoices

salesInvoice*

SalesReturn Carrier SalesInvoices

 

X

 

 

association 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoices

purchaseInvoice*

SalesReturn Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery back from the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesReturn Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Return. See TaxCode definition.  

carrierReference

normalizedString

SalesReturn Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

SalesReturn Currency

 

 

 

 

 

The currency of the Sales Return (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

SalesReturn OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesReturn OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Return Currency into Sales Return OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesReturn OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Return Currency to Sales Return OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Return Values in Sales Return Currency / Sales Return Operating Company Currency Exchange Rate = Sales Return Values in Sales Return OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesReturn OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Return Currency to Sales Return OperatingCompany Currency, if different. Default = System date  

creditCurrency

normalizedString

SalesReturn Credit Currency

 

X

 

 

 

The currency to be used on credit notes associated with this Return. ISO 4217. Could be derived from Return currency.  

creditCurrencyExchangeRate

decimal

SalesReturn Credit Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Return Currency into Sales Return Credit Currency, if different.  

creditCurrencyExchangeRateOperator

rateOperator

SalesReturn Credit Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Return Currency to Sales Return Credit Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Return Values in Sales Return Currency / Sales Return Credit Currency Exchange Rate = Sales Return Values in Sales Return Credit Currency.  

creditCurrencyExchangeRateDate

date

SalesReturn Credit Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Return Currency to Sales Return Credit Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesReturn Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Customer Trading Account on the Sales Return. ISO 4217. Could be derived from order currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesReturn Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Return currency into the Customer Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesReturn Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Return Currency to Sales Return Customer Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Return Values in Sales Return Currency / Sales Return Customer TradingAccount Currency Exchange Rate = Sales Return Values in Sales Return Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesReturn Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Return Currency to Customer Trading Account Currency, if different. Default = System date  

date

date

SalesReturn Date

 

 

 

 

 

Date the Sales Return was placed. 

time

time

SalesReturn Time

 

X

 

 

 

Time the Sales Return was placed. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

validity

decimal

SalesReturn Validity

 

X

 

 

 

Period the Sales Return is valid for (days from Return Date).  

expirationDate

date

SalesReturn Expiration Date

 

X

 

 

 

The expiration date of the Sales Return (SalesReturn Date + Validity).  

taxCodes

taxCode*

SalesReturn Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Return. See TaxCode definition.  

buyerContact

contact

SalesReturn Buyer Contact

 

X

 

 

reference 

Link to the Contact at Customer who placed the Sales Return. See Contact definition.  

salesPersons

salesPerson*

SalesReturn SalesPersons

 

X

 

 

association 

Sales person associated with the Sales Return. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

salesReturnLines

salesReturnLine*

SalesReturn SalesReturnLine

 

 

 

 

child 

Sales Return Line detail (e.g. items on the Sales Return). See SalesReturnLine definition.  

lineCount

decimal

SalesReturn Line Count

 

 

 

 

 

The number of lines on the Sales Return. Should be auto-populated. Used as a cross reference to ensure Return integrity.  

returnDiscountType

discountType

SalesReturn Return Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return (percent or amount). From the Trading Account.  

returnDiscountAmount

decimal

SalesReturn Return Discount Amount

 

X

 

 

 

Discount applicable to the Sales Return expressed as an amount. From the Trading Account.  

returnDiscountPercent

decimal

SalesReturn Return Discount Percent

 

X

 

 

 

Discount applicable to the Sales Return expressed as a percent. From the Trading Account.  

returnAdditionalDiscount1Type

discountType

SalesReturn Return Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return (percent or amount)  

returnAdditionalDiscount1Amount

decimal

SalesReturn Return Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Sales Return expressed as an amount.  

returnAdditionalDiscount1Percent

decimal

SalesReturn Return Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Sales Return expressed as a percent.  

returnAdditionalDiscount2Type

discountType

SalesReturn Return Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return (percent or amount)  

returnAdditionalDiscount2Amount

decimal

SalesReturn Return Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Sales Return expressed as an amount.  

returnAdditionalDiscount2Percent

decimal

SalesReturn Return Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Sales Return expressed as a percent.  

text1

string

SalesReturn Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Return. Header text.  

text2

string

SalesReturn Text2

 

X

 

 

 

Further text/commentary for the Sales Return. Footer text.  

netTotal

decimal

SalesReturn Net Total

 

 

 

 

 

Total value of the Sales Return, including discounts, excluding tax. In Return currency.  

discountTotal

decimal

SalesReturn Discount Total

 

 

 

 

 

Total discounts applied to the Return. In Return currency  

chargesTotal

decimal

SalesReturn Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Return (e.g. finance charges, interest). In Return currency.  

taxTotal

decimal

SalesReturn Tax Total

 

 

 

 

 

Total tax applicable to the Sales Return. In Return currency.  

grossTotal

decimal

SalesReturn Gross Total

 

 

 

 

 

Total value of the Sales Return, including tax & discounts & charges. In Return currency.  

costTotal

decimal

SalesReturn Cost Total

 

X

 

 

 

Total cost of the Sales Return. In Return currency.  

profitTotal

decimal

SalesReturn Profit Total

 

X

 

 

 

Total profit on the Sales Return (e.g. net total - cost total). In Return currency.  

payments

payment*

SalesReturn Payment

 

X

 

 

association 

Link to the Sales Return Payment (e.g. if refund is entered with the Return). See Payment definition.  

contract

string

SalesReturn Contract

 

X

 

 

 

Reference to a contract associated with the Sales Return.  

creditTradingAccount

tradingAccount

SalesReturn Credit TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be credited for the Sales Return (if different from the Customer). See TradingAccount definition.  

returnCountry

normalizedString

SalesReturn Return Country

 

X

 

 

 

Country of destination for the Sales Return (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Delivery address?  

projects

project*

SalesReturn Project

 

X

 

 

association 

Identifier of the Project this Sales Return is for. See Project definition.  

projectLines

projectLine*

SalesReturn ProjectLine

 

X

 

 

association 

Project Line value for this Sales Return. See Project Line definition. Some applications may not have Project Lines.  

cases

case*

SalesReturn Cases

 

X

 

 

association 

The reference of the case associated with the Sales Return, e.g. if the Return is for repair/fix services. A Case entity has been defined to support the F2F process.  

salesReturnDeliveries

salesReturnDelivery*

SalesReturn SalesReturnDelivery

 

X

 

 

association 

Link to the Delivery (dispatch) against the Sales Return. If there are multiple then these are held against the Sales Return Line. See SalesReturnDeliveries definition.  

financialAccounts

financialAccount*

SalesReturn FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Return. See FinancialAccount definition.  

costCentres

costCentre*

SalesReturn CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Return. See Cost Centre definition.  

departments

department*

SalesReturn Departments

 

X

 

 

association 

Department(s) associated with this Sales Return. See Department definition.  

interactions

interaction*

SalesReturn Interactions

 

X

 

 

association 

Interaction(s) associated with the Sales Return. See Interaction definition.  

user

normalizedString

SalesReturn User

 

X

 

 

 

Link to the user who placed the Sales Return. The user resource will be defined in the future.  

notes

note*

SalesReturn Note

 

X

 

 

child 

Notes associated with a Sales Return. 

Top  

Resource salesReturnLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesReturn

salesReturn

SalesReturnLine Sales Return

 

 

 

 

parent 

The parent SalesReturn 

active

boolean

SalesReturnLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Return Line is an active one. Default = True  

reference

normalizedString

SalesReturnLine Reference

X

 

 

 

 

Reference for the Sales Return Line. 

reference2

normalizedString

SalesReturnLine Reference2

 

X

 

 

 

Additional reference for the Sales Return Line. 

number

decimal

SalesReturnLine Number

 

 

 

 

 

The number of the Sales Return Line. For sequencing and ordering of lines.  

status

salesReturnStatus

SalesReturnLine Status

 

X

 

 

 

Status of the Sales Return Line. 

type

lineType

SalesReturnLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Return Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

reason

string

SalesReturnLine Reason

 

X

 

 

 

Reason for the Sales Return Line. The return reason may be different for each Line.  

deliveryTerms

normalizedString

SalesReturnLine Delivery Terms

 

X

 

 

 

The terms for Delivery for this Sales Return Line. Also on Sales Return.  

carrierTradingAccount

tradingAccount

SalesReturnLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Return Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

SalesReturnLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Return currency.  

carrierTaxPrice

decimal

SalesReturnLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Return currency. 

carrierTotalPrice

decimal

SalesReturnLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Return currency.  

carrierSalesInvoiceLine

salesInvoice

SalesReturnLine Carrier SalesInvoice

 

X

 

 

reference 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoiceLine

purchaseInvoice

SalesReturnLine Carrier PurchaseInvoice

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery back from the Customer. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

SalesReturnLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Return Line. See TaxCode definition.  

carrierReference

normalizedString

SalesReturnLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

commodity

commodity

SalesReturnLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Return Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

SalesReturnLine Text

 

X

 

 

 

Text applicable to the Sales Return Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Return Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesReturnLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Sales Return Line. See Variant definition.  

commodityDimension

commodityDimension

SalesReturnLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the Sales Return Line. See Dimension definition.  

commodityCondition

string

SalesReturnLine Commodity Condition

 

X

 

 

 

Condition of the Commodity being returned on the Sales Return Line.  

fulfillmentLocation

location

SalesReturnLine Delivery Location

 

X

 

 

reference 

The Location to which the Sales Return Line will be delivered (e.g. the warehouse holding the Commodity). See Location definition.  

unitOfMeasure

unitOfMeasure

SalesReturnLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

SalesReturnLine Quantity

 

 

 

X

 

The quantity of the Commodity Returned on the Sales Return Line.  

initialPrice

decimal

SalesReturnLine Initial Price

 

 

 

 

 

The initial price of the Commodity Returned on the Sales Return Line (e.g. before discounts). In Return currency.  

pricelist

priceList

SalesReturnLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Sales Return Line. See PriceList definition.  

returnLineDiscountType

discountType

SalesReturnLine Return Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return Line (percent or amount). From the Sales Return.  

returnLineDiscountAmount

decimal

SalesReturnLine Return Line Discount Amount

 

X

 

 

 

Discount applicable to the Sales Return Line, expressed as an amount. From the Sales Return.  

returnLineDiscountPercent

decimal

SalesReturnLine Return Line Discount Percent

 

X

 

 

 

Discount applicable to the Sales Return Line, expressed as a percentage. From the Sales Return.  

returnLineSubtotalDiscountType

discountType

SalesReturnLine Return Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Return Lines (percent or amount) of which this Line is part.  

returnLineSubtotalDiscountAmount

decimal

SalesReturnLine Return Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Return Line, expressed as an amount.  

returnLineSubtotalDiscountPercent

decimal

SalesReturnLine Return Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Return Line, expressed as a percentage.  

actualPrice

decimal

SalesReturnLine Actual Price

 

 

 

 

 

The actual price of the Commodity Returned on the Sales Return Line (e.g. after discounts or adjustments). In Return currency.  

netTotal

decimal

SalesReturnLine Net Total

 

 

 

 

 

Total value of the Sales Return Line, including discounts, excluding tax (e.g. quantity * actual price). In Return currency. Could be calculated.  

chargesTotal

decimal

SalesReturnLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Return Line (e.g. finance charges, interest). In Return currency.  

discountTotal

decimal

SalesReturnLine Discount Total

 

 

 

 

 

Total discounts applied to the return line. In return currency  

fobPoint

string

SalesReturnLine FOB Point

 

X

 

 

 

The FOB point applicable to the Sales Return Line. FOB is an abbreviation for Free On Board. The term FOB is used when shipping goods, to indicate who pays loading and transportation costs, and/or the point at which the responsibility of the goods transfers from shipper to buyer  

taxCodes

taxCode*

SalesReturnLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Return Line (default value from Sales Return). See TaxCode definition.  

priceTax

decimal

SalesReturnLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Return Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesReturnLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Return Line. In Return currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesReturnLine Gross Total

 

 

 

 

 

Total value of the Sales Return Line, including discounts & tax & charges. In Return currency.  

costTotal

decimal

SalesReturnLine Cost Total

 

X

 

 

 

Total cost of the Sales Return Line. In Return currency.  

profitTotal

decimal

SalesReturnLine Profit Total

 

X

 

 

 

Total profit on the Sales Return Line (e.g. net total - cost total). In Return currency.  

salesCreditLines

salesCreditLine*

SalesReturnLine SalesCreditLine

 

X

 

 

association 

Sales Credit Line(s) associated with the Sales Return Line. See SalesCreditLine definition.  

payments

payment*

SalesReturnLine Payment

 

X

 

 

association 

A link to the (cash) payment(s) associated with this Sales Return Line See Receipt definition.  

paymentLines

paymentLine*

SalesReturnLine PaymentLine

 

X

 

 

association 

A link to the (cash) payment line(s) associated with this Sales Return Line. See ReceiptLine definition.  

buyerContact

contact

SalesReturnLine Buyer Contact

 

X

 

 

reference 

Link to the Sales Return Line originator (buyer Contact). See Contact definition. This could be derived from the Sales Return  

project

project

SalesReturnLine Project

 

X

 

 

reference 

Identifier of the Project this Sales Return Line is for. See Project definition.  

projectLine

projectLine

SalesReturnLine ProjectLine

 

X

 

 

reference 

Project Line value for this Sales Return Line. See Project Line definition. Some applications may not have Project Lines.  

salesReturnDeliveryLines

salesReturnDeliveryLine*

SalesReturnLine SalesReturnDeliveryLines

 

X

 

 

association 

Link to the Delivery (dispatch) Line against the Sales Return Line. See SalesReturnDeliveryLines definition.  

financialAccounts

financialAccount*

SalesReturnLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Return Line. See FinancialAccount definition.  

costCentres

costCentre*

SalesReturnLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Return Line. See Cost Centre definition.  

departments

department*

SalesReturnLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Return Line. See Department definition.  

notes

note*

SalesReturnLine Note

 

X

 

 

child 

Notes associated with a Sales Return Line. 

originatorDocumentLines

salesReturnLineOriginatorDocumentLine*

SalesReturnLine Originator Document Line References

 

X

 

 

association 

Reference to Lines on another document (e.g. the sales order Line or bill Line associated with the Invoice Line). Sales Return Lines are often associated with Sales Order Lines. Could also include a link to the original Invoice Line if an Invoice is cancelled (reversed).  

Top  

Resource salesOrderDelivery

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesOrderDelivery Active Flag

 

 

 

 

 

Flag to indicate if the Sales Order Delivery is an active one. Default = True  

salesOrders

salesOrder*

SalesOrderDelivery Sales Orders

 

 

 

 

association 

Link to the Sales Order associated with the Delivery. See SalesOrder definition.  

reference

normalizedString

SalesOrderDelivery Reference

X

 

 

 

 

Reference for the Sales Order Delivery. 

reference2

normalizedString

SalesOrderDelivery Reference2

 

X

 

 

 

Additional reference for the Sales Order Delivery.  

status

salesOrderDeliveryLineStatus

SalesOrderDelivery Status

 

X

 

 

 

Status of the Sales Order Delivery (e.g. Part, Complete).  

tradingAccount

tradingAccount

SalesOrderDelivery Customer TradingAccount

 

 

 

 

reference 

Link to the Sales Order Delivery Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesOrderDelivery Customer Reference

 

X

 

 

 

Customer own reference for the Sales Order Delivery (e.g. a Delivery booking number).  

pricelist

priceList

SalesOrderDelivery PriceList

 

X

 

 

reference 

Link to the Price List used when generating (additional sales) on the sales order Delivery. See PriceList definition.  

supplierTradingAccount

tradingAccount

SalesOrderDelivery Supplier TradingAccount

 

X

 

 

reference 

Link to the Sales Order Delivery Supplier account (e.g. for back to back ordering). See TradingAccount definition.  

supplierReference

normalizedString

SalesOrderDelivery Supplier Reference

 

X

 

 

 

Supplier own reference for the Sales Order Delivery (e.g. a Delivery booking number)..  

type

normalizedString

SalesOrderDelivery Type

 

X

 

 

 

The Sales Order Delivery type. 

postalAddress

postalAddress

SalesOrderDelivery PostalAddress

 

X

 

 

child 

Link to the actual Delivery (shipping) address for the Sales Order Delivery. See PostalAddress definition. May be different from that originally requested on the Sales Order.  

deliveryMethod

normalizedString

SalesOrderDelivery Method

 

X

 

 

 

Delivery method employed for Sales Order Delivery (e.g. Courier, Collection, etc). May be different from that requested on the Sales Order.  

carrierTradingAccount

tradingAccount

SalesOrderDelivery Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Order Delivery. See TradingAccount definition. Carriers are not used by all application.  

carrierTaxCodes

taxCode*

SalesOrderDelivery Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this sales order Delivery. See TaxCode definition.  

carrierReference

normalizedString

SalesOrderDelivery Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

carrierNetPrice

decimal

SalesOrderDelivery Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Delivery currency.  

carrierTaxPrice

decimal

SalesOrderDelivery Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Delivery currency.  

carrierTotalPrice

decimal

SalesOrderDelivery Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Delivery currency.  

carrierSalesInvoice

salesInvoice

SalesOrderDelivery Carrier SalesInvoice

 

X

 

 

reference 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoice

purchaseInvoice

SalesOrderDelivery Carrier PurchaseInvoice

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

currency

normalizedString

SalesOrderDelivery Currency

 

X

 

 

 

The currency of the Sales Order Delivery (e.g. GBP, USD, EUR). ISO 4217. Must be same as the associated Sales Order currency. Not mandatory as some applications do not hold financial information against deliveries.  

operatingCompanyCurrency

normalizedString

SalesOrderDelivery OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesOrderDelivery OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Order Delivery Currency into Sales Order Delivery OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesOrderDelivery OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Order Delivery Currency to Sales Order Delivery OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Order Delivery Values in Sales Order Delivery Currency / Sales Order Delivery Operating Company Currency Exchange Rate = Sales Order Delivery Values in Sales Order Delivery OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesOrderDelivery OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Order Delivery Currency to Sales Order Delivery OperatingCompany Currency, if different. Default = System date  

invoiceCurrency

normalizedString

SalesOrderDelivery Invoice Currency

 

X

 

 

 

The currency to be used on invoices associated with this sales order Delivery. ISO 4217. Could be derived from order currency.  

invoiceCurrencyExchangeRate

decimal

SalesOrderDelivery Invoice Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Order Delivery Currency into Sales Order Delivery Invoice Currency, if different.  

invoiceCurrencyExchangeRateOperator

rateOperator

SalesOrderDelivery Invoice Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Order Delivery Currency to Sales Order Delivery Invoice Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Order Delivery Values in Sales Order Delivery Currency / Sales Order Delivery Invoice Currency Exchange Rate = Sales Order Delivery Values in Sales Order Delivery Invoice Currency.  

invoiceCurrencyExchangeRateDate

date

SalesOrderDelivery Invoice Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Order Delivery Currency to Sales Order Delivery Invoice Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesOrderDelivery Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Customer Trading Account on the Sales Order Delivery. ISO 4217. Could be derived from order currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesOrderDelivery Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Order Delivery currency into the Customer Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesOrderDelivery Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Order Delivery Currency to Sales Order Delivery Customer Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Order Delivery Values in Sales Order Delivery Currency / Sales Order Delivery Customer Trading Account Currency Exchange Rate = Sales Order Delivery Values in Sales Order Delivery Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesOrderDelivery Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Order Delivery Currency to Customer Trading Account Currency, if different. Default = System date  

requestedDeliveryDate

date

SalesOrderDelivery Requested Delivery Date

 

X

 

 

 

The requested date of the Delivery, from the Sales Order.  

actualDeliveryDate

date

SalesOrderDelivery Actual Delivery Date

 

 

 

 

 

The actual date of the Sales Order Delivery. 

actualDeliveryTime

time

SalesOrderDelivery Actual Delivery Time

 

X

 

 

 

The actual time of the Sales Order Delivery. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dateExceptionReason

string

SalesOrderDelivery Date Exception Reason

 

X

 

 

 

A reason for the difference in Delivery dates for the Sales Order, if any.  

taxCodes

taxCode*

SalesOrderDelivery Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this sales order Delivery. See TaxCode definition.  

deliveryContact

contact

SalesOrderDelivery Delivery Contact

 

X

 

 

reference 

Link to the Contact at Customer who took delivery of the Sales Order. See Contact definition. Default = Primary TradingAccount Contact  

salesOrderDeliveryLines

salesOrderDeliveryLine*

SalesOrderDelivery SalesOrderDeliveryLine

 

 

 

 

child 

Sales Order Delivery Line detail (e.g. items on the Sales Order Delivery). See SalesOrderDeliveryLine definition.  

lineCount

decimal

SalesOrderDelivery Line Count

 

 

 

 

 

The number of lines on the Sales Order Delivery. Should be auto-populated. Used as a cross reference to ensure order integrity.  

requestedQuantity

decimal

SalesOrderDelivery Requested Quantity

 

X

 

 

 

The total quantity of the Commodity requested on the Sales Order Delivery (from associated sales orders).  

deliveredQuantity

decimal

SalesOrderDelivery Delivered Quantity

 

 

 

 

 

The total quantity of the Commodity delivered on the Sales Order Delivery.  

deliveryDiscountType

discountType

SalesOrderDelivery Delivery Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this sales order Delivery (percent or amount). From the Trading Account or sales order.  

deliveryDiscountAmount

decimal

SalesOrderDelivery Delivery Discount Amount

 

X

 

 

 

Discount applicable to the sales order Delivery expressed as an amount. From the Trading Account or sales order.  

deliveryDiscountPercent

decimal

SalesOrderDelivery Delivery Discount Percent

 

X

 

 

 

Discount applicable to the sales order Delivery expressed as a percent. From the Trading Account or sales order.  

deliveryAdditionalDiscount1Type

discountType

SalesOrderDelivery Delivery Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this sales order Delivery (percent or amount)  

deliveryAdditionalDiscount1Amount

decimal

SalesOrderDelivery Delivery Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the sales order Delivery expressed as an amount.  

deliveryAdditionalDiscount1Percent

decimal

SalesOrderDelivery Delivery Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the sales order Delivery expressed as a percent.  

deliveryAdditionalDiscount2Type

discountType

SalesOrderDelivery Delivery Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this sales order Delivery (percent or amount)  

deliveryAdditionalDiscount2Amount

decimal

SalesOrderDelivery Delivery Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the sales order Delivery expressed as an amount.  

deliveryAdditionalDiscount2Percent

decimal

SalesOrderDelivery Delivery Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the sales order Delivery expressed as a percent.  

text1

string

SalesOrderDelivery Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Order Delivery. Header text.  

text2

string

SalesOrderDelivery Text2

 

X

 

 

 

Further text/commentary for the Sales Order Delivery. Footer text.  

netTotal

decimal

SalesOrderDelivery Net Total

 

 

 

 

 

Total value of the sales order Delivery, including discounts, excluding tax. In Delivery currency.  

discountTotal

decimal

SalesOrderDelivery Discount Total

 

 

 

 

 

Total discounts applied to the Delivery. In Delivery currency.  

chargesTotal

decimal

SalesOrderDelivery Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Order Delivery (e.g. finance charges, interest). In Delivery currency.  

taxTotal

decimal

SalesOrderDelivery Tax Total

 

 

 

 

 

Total tax applicable to the sales order Delivery. In Delivery currency.  

grossTotal

decimal

SalesOrderDelivery Gross Total

 

 

 

 

 

Total value of the sales order Delivery, including tax & discounts & charges. In Delivery currency.  

costTotal

decimal

SalesOrderDelivery Cost Total

 

X

 

 

 

Total cost of the sales order Delivery. In Delivery currency.  

profitTotal

decimal

SalesOrderDelivery Profit Total

 

X

 

 

 

Total profit on the sales order Delivery (e.g. net total - cost total). In order currency.  

receipts

receipt*

SalesOrderDelivery Receipt

 

X

 

 

association 

Link to the Sales Order Delivery receipt(s) (if any). See Receipt definition.  

invoiceTradingAccount

tradingAccount

SalesOrderDelivery Invoice TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be invoiced for the Sales Order Delivery (if different from the Customer), e.g. Bill To. See TradingAccount definition.  

invoiceCountry

normalizedString

SalesOrderDelivery Invoice Country

 

X

 

 

 

Country to which the Sales Invoice delivery is sent (e.g. for taxation purposes). ISO 3166-1 alpha-2 country codes only  

deliveryCountry

normalizedString

SalesOrderDelivery Delivery Country

 

X

 

 

 

Country of destination for the Sales Order Delivery (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Delivery address?  

originCountry

normalizedString

SalesOrderDelivery Origin Country

 

X

 

 

 

Country of origin for the Sales Order Delivery (e.g. for intrastat purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Operating Company address?  

typeOfBusiness

normalizedString

SalesOrderDelivery Type Of Business

 

X

 

 

 

Type of Business for intrastat purposes. 

statisticalProcess

normalizedString

SalesOrderDelivery Statistical Process

 

X

 

 

 

Statistic method for intrastat purposes. 

user

normalizedString

SalesOrderDelivery User

 

X

 

 

 

The user responsible for the Sales Order Delivery, e.g. the person dispatching the Sales Order. The user resource will be defined in the future.  

cases

case*

SalesOrderDelivery Cases

 

X

 

 

association 

The reference of the case associated with the Sales Order Delivery, e.g. if the Case is for fault incurred during delivery. A Case entity has been defined to support the F2F process.  

financialAccounts

financialAccount*

SalesOrderDelivery FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Order Delivery. See FinancialAccount definition.  

costCentres

costCentre*

SalesOrderDelivery CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Order Delivery. See Cost Centre definition.  

departments

department*

SalesOrderDelivery Departments

 

X

 

 

association 

Department(s) associated with this Sales Order Delivery. See Department definition.  

interactions

interaction*

SalesOrderDelivery Interactions

 

X

 

 

association 

Interaction(s) associated with the sales order Delivery. See Interaction definition.  

notes

note*

SalesOrderDelivery Note

 

X

 

 

child 

Notes associated with a Sales Order Delivery. 

Top  

Resource salesOrderDeliveryLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesOrderDelivery

salesOrderDelivery

SalesOrderDeliveryLine SalesOrderDelivery

 

 

 

X

parent 

The Sales Order Delivery this Line belongs to. See SalesOrderDelivery definition.  

active

boolean

SalesOrderDeliveryLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Order Delivery Line is an active one. Default = True  

reference

normalizedString

SalesOrderDeliveryLine Reference

X

 

 

 

 

Reference for the Sales Order Delivery Line. 

reference2

normalizedString

SalesOrderDeliveryLine Reference2

 

X

 

 

 

Additional reference for the Sales Order Delivery Line.  

number

decimal

SalesOrderDeliveryLine Number

 

 

 

 

 

The number of the Sales Order Delivery Line. For sequencing and ordering of lines.  

status

salesOrderDeliveryLineStatus

SalesOrderDeliveryLine Status

 

X

 

 

 

Status of the Sales Order Delivery Line (e.g. Part, Complete).  

type

lineType

SalesOrderDeliveryLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Order Delivery Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

commodity

commodity

SalesOrderDeliveryLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Order Delivery Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

SalesOrderDeliveryLine Text

 

X

 

 

 

Text applicable to the Sales Order Delivery Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Order Delivery Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesOrderDeliveryLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the sales order Delivery Line. See Variant definition.  

commodityDimension

commodityDimension

SalesOrderDeliveryLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity delivered on the sales order Delivery Line. See Dimension definition.  

fulfillmentLocation

location

SalesOrderDeliveryLine Fulfillment Location

 

X

 

 

reference 

The Location from which the Sales Order Delivery Line was fulfilled. See Location definition.  

fulfillmentSubLocation

location

SalesOrderDeliveryLine Fulfilment Sub-Location

 

X

 

 

reference 

The sub-Location from which the Sales Order Delivery Line was fulfilled. See Location definition.  

requestedDeliveryDate

date

SalesOrderDeliveryLine Requested Delivery Date

 

X

 

 

 

The requested date of the Delivery Line, from the Sales Order.  

actualDeliveryDate

date

SalesOrderDeliveryLine Actual Delivery Date

 

 

 

 

 

The actual date of the Sales Order Delivery Line. 

actualDeliveryTime

time

SalesOrderDeliveryLine Actual Delivery Time

 

X

 

 

 

The actual time of the Sales Order Delivery Line. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dateExceptionReason

string

SalesOrderDeliveryLine Date Exception Reason

 

X

 

 

 

A reason for the difference in Delivery dates for the Sales Order Delivery Line, if any.  

unitOfMeasure

unitOfMeasure

SalesOrderDeliveryLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

requestedQuantity

decimal

SalesOrderDeliveryLine Requested Quantity

 

X

 

 

 

The quantity of the Commodity requested on the Sales Order Delivery Line.  

deliveredQuantity

decimal

SalesOrderDeliveryLine Delivered Quantity

 

 

 

 

 

The quantity of the Commodity delivered on the Sales Order Delivery Line.  

initialPrice

decimal

SalesOrderDeliveryLine Initial Price

 

 

 

 

 

The initial price of the Commodity ordered on the Sales Order Delivery Line (e.g. before discounts). In Delivery currency.  

pricelist

priceList

SalesOrderDeliveryLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Sales Order Delivery Line. See PriceList definition.  

deliveryLineDiscountType

discountType

SalesOrderDeliveryLine Delivery Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Order Delivery Line (percent or amount). From the trading account or sales order.  

deliveryLineDiscountAmount

decimal

SalesOrderDeliveryLine Delivery Line Discount Amount

 

X

 

 

 

Discount applicable to the Sales Order Delivery Line, expressed as an amount. From the trading account or sales order.  

deliveryLineDiscountPercent

decimal

SalesOrderDeliveryLine Delivery Line Discount Percent

 

X

 

 

 

Discount applicable to the Sales Order Delivery Line, expressed as a percentage. From the trading account or sales order.  

deliveryLineSubtotalDiscountType

discountType

SalesOrderDeliveryLine Delivery Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Order Delivery Lines (percent or amount) of which this Line is part.  

deliveryLineSubtotalDiscountAmount

decimal

SalesOrderDeliveryLine Delivery Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Order Delivery Line, expressed as an amount.  

deliveryLineSubtotalDiscountPercent

decimal

SalesOrderDeliveryLine Delivery Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Order Delivery Line, expressed as a percentage.  

actualPrice

decimal

SalesOrderDeliveryLine Actual Price

 

 

 

 

 

The actual price of the Commodity ordered on the Sales Order Delivery Line (e.g. after discounts or adjustments). In Delivery currency.  

netTotal

decimal

SalesOrderDeliveryLine Net Total

 

 

 

 

 

Total value of the Sales Order Delivery Line, including discounts, excluding tax (e.g. quantity * actual price). In Delivery currency. Could be calculated.  

chargesTotal

decimal

SalesOrderDeliveryLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Order Delivery Line (e.g. finance charges, interest). In Delivery currency.  

discountTotal

decimal

SalesOrderDeliveryLine Discount Total

 

 

 

 

 

Total discounts applied to the order delivery line. In delivery currency  

taxCodes

taxCode*

SalesOrderDeliveryLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Order Delivery Line (default value from sales order). See TaxCode definition.  

priceTax

decimal

SalesOrderDeliveryLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Order Delivery Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesOrderDeliveryLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Order Delivery Line. In Delivery currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesOrderDeliveryLine Gross Total

 

 

 

 

 

Total value of the Sales Order Delivery Line, including discounts & tax & charges. In Delivery currency.  

costTotal

decimal

SalesOrderDeliveryLine Cost Total

 

X

 

 

 

Total cost of the sales order Delivery Line. In Delivery currency.  

profitTotal

decimal

SalesOrderDeliveryLine Profit Total

 

X

 

 

 

Total profit on the sales order Delivery Line (e.g. net total - cost total). In Delivery currency.  

salesInvoiceLines

salesInvoiceLine*

SalesOrderDeliveryLine Sales Invoice Line

 

X

 

 

association 

Sales Invoice Line(s) associated with the Sales Order Delivery Line. See SalesInvoiceLine definition.  

receipts

receipt*

SalesOrderDeliveryLine Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Sales Order Line. See Receipt definition.  

financialAccounts

financialAccount*

SalesOrderDeliveryLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Order Delivery Line. See FinancialAccount definition.  

costCentres

costCentre*

SalesOrderDeliveryLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Order Delivery Line. See Cost Centre definition.  

departments

department*

SalesOrderDeliveryLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Order Delivery Line. See Department definition.  

notes

note*

SalesOrderDeliveryLine Note

 

X

 

 

child 

Notes associated with a Sales Order Delivery Line.  

Top  

Resource salesReturnDelivery

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesReturnDelivery Active Flag

 

 

 

 

 

Flag to indicate if the Sales Return Delivery is an active one. Default = True  

salesOrders

salesOrder*

SalesReturnDelivery Sales Orders

 

 

 

 

association 

Link to the Sales Order associated with the Delivery. See SalesOrder definition.  

reference

normalizedString

SalesReturnDelivery Reference

X

 

 

 

 

Reference for the Sales Return Delivery. 

reference2

normalizedString

SalesReturnDelivery Reference2

 

X

 

 

 

Additional reference for the Sales Return Delivery.  

status

salesReturnDeliveryStatus

SalesReturnDelivery Status

 

X

 

 

 

Status of the Sales Return Delivery (e.g. Part, Complete).  

tradingAccount

tradingAccount

SalesReturnDelivery Customer TradingAccount

 

 

 

 

reference 

Link to the Sales Return Delivery Customer account. See TradingAccount definition.  

customerReference

normalizedString

SalesReturnDelivery Customer Reference

 

X

 

 

 

Customer own reference for the Sales Return Delivery (e.g. a Delivery booking number).  

pricelist

priceList

SalesReturnDelivery PriceList

 

X

 

 

reference 

Link to the Price List used when generating (additional sales) on the Sales Return Delivery. See PriceList definition.  

supplierTradingAccount

tradingAccount

SalesReturnDelivery Supplier TradingAccount

 

X

 

 

reference 

Link to the Sales Return Delivery Supplier account (e.g. for back to back ordering). See TradingAccount definition.  

supplierReference

normalizedString

SalesReturnDelivery Supplier Reference

 

X

 

 

 

Supplier own reference for the Sales Return Delivery (e.g. a Delivery booking number)..  

type

normalizedString

SalesReturnDelivery Type

 

X

 

 

 

The Sales Return Delivery type. 

postalAddress

postalAddress

SalesReturnDelivery PostalAddress

 

X

 

 

child 

Link to the actual Delivery (shipping) address for the Sales Return Delivery. See PostalAddress definition. May be different from that originally requested on the Sales Order.  

deliveryMethod

normalizedString

SalesReturnDelivery Method

 

X

 

 

 

Delivery method employed for Sales Return Delivery (e.g. Courier, Collection, etc). May be different from that requested on the Sales Order.  

carrierTradingAccount

tradingAccount

SalesReturnDelivery Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Sales Return Delivery. See TradingAccount definition. Carriers are not used by all application.  

carrierTaxCodes

taxCode*

SalesReturnDelivery Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Sales Return Delivery. See TaxCode definition.  

carrierReference

normalizedString

SalesReturnDelivery Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

carrierNetPrice

decimal

SalesReturnDelivery Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Delivery currency.  

carrierTaxPrice

decimal

SalesReturnDelivery Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Delivery currency.  

carrierTotalPrice

decimal

SalesReturnDelivery Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Delivery currency.  

carrierSalesInvoice

salesInvoice

SalesReturnDelivery Carrier SalesInvoice

 

X

 

 

reference 

A link to the Sales Invoice generated to recharge the carriage to the Customer. See SalesInvoice definition.  

carrierPurchaseInvoice

purchaseInvoice

SalesReturnDelivery Carrier PurchaseInvoice

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Customer. See PurchaseInvoice definition.  

currency

normalizedString

SalesReturnDelivery Currency

 

X

 

 

 

The currency of the Sales Return Delivery (e.g. GBP, USD, EUR). ISO 4217. Must be same as the associated Sales Order currency. Not mandatory as some applications do not hold financial information against deliveries.  

operatingCompanyCurrency

normalizedString

SalesReturnDelivery OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

SalesReturnDelivery OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Return Delivery Currency into Sales Return Delivery OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

SalesReturnDelivery OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Return Delivery Currency to Sales Return Delivery OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Return Delivery Values in Sales Return Delivery Currency / Sales Return Delivery Operating Company Currency Exchange Rate = Sales Return Delivery Values in Sales Return Delivery OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

SalesReturnDelivery OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Return Delivery Currency to Sales Return Delivery OperatingCompany Currency, if different. Default = System date  

invoiceCurrency

normalizedString

SalesReturnDelivery Invoice Currency

 

X

 

 

 

The currency to be used on invoices associated with this Sales Return Delivery. ISO 4217. Could be derived from order currency.  

invoiceCurrencyExchangeRate

decimal

SalesReturnDelivery Invoice Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Sales Return Delivery Currency into Sales Return Delivery Invoice Currency, if different.  

invoiceCurrencyExchangeRateOperator

rateOperator

SalesReturnDelivery Invoice Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Return Delivery Currency to Sales Return Delivery Invoice Currency. * (multiplication) or / division. E.g. if the operator is division then it is Sales Return Delivery Values in Sales Return Delivery Currency / Sales Return Delivery Invoice Currency Exchange Rate = Sales Return Delivery Values in Sales Return Delivery Invoice Currency.  

invoiceCurrencyExchangeRateDate

date

SalesReturnDelivery Invoice Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Return Delivery Currency to Sales Return Delivery Invoice Currency, if different. Default = System date  

customerTradingAccountCurrency

normalizedString

SalesReturnDelivery Customer TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Customer Trading Account on the Sales Order Delivery. ISO 4217. Could be derived from order currency.  

customerTradingAccountCurrencyExchangeRate

decimal

SalesReturnDelivery Customer TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Sales Return Delivery currency into the Customer Trading Account currency, if different.  

customerTradingAccountCurrencyExchangeRateOperator

rateOperator

SalesReturnDelivery Customer TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Sales Return Delivery Currency to Sales Return Delivery Customer Trading Account Currency * (multiplication) or / division. E.g. if the operator is division then it is Sales Return Delivery Values in Sales Return Delivery Currency / Sales Return Delivery Customer Trading Account Currency Exchange Rate = Sales Return Delivery Values in Sales Return Delivery Customer TradingAccount Currency.  

customerTradingAccountCurrencyExchangeRateDate

date

SalesReturnDelivery Customer TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Sales Return Delivery Currency to Customer Trading Account Currency, if different. Default = System date  

requestedDeliveryDate

date

SalesReturnDelivery Requested Delivery Date

 

X

 

 

 

The requested date of the Delivery, from the Sales Order.  

actualDeliveryDate

date

SalesReturnDelivery Actual Delivery Date

 

 

 

 

 

The actual date of the Sales Return Delivery. 

actualDeliveryTime

time

SalesReturnDelivery Actual Delivery Time

 

X

 

 

 

The actual time of the Sales Return Delivery. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dateExceptionReason

string

SalesReturnDelivery Date Exception Reason

 

X

 

 

 

A reason for the difference in Delivery dates for the Sales Order, if any.  

taxCodes

taxCode*

SalesReturnDelivery Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Return Delivery. See TaxCode definition.  

deliveryContact

contact

SalesReturnDelivery Return Contact

 

X

 

 

reference 

Link to the Contact at Customer who sent the Sales Order Return Delivery. See Contact definition. Default = Primary TradingAccount Contact  

salesReturnDeliveryLines

salesReturnDeliveryLine*

SalesReturnDelivery SalesReturnDeliveryLine

 

 

 

 

child 

Sales Return Delivery Line detail (e.g. items on the Sales Return Delivery). See SalesReturnDeliveryLine definition.  

lineCount

decimal

SalesReturnDelivery Line Count

 

 

 

 

 

The number of lines on the Sales Return Delivery. Should be auto-populated. Used as a cross reference to ensure order integrity.  

requestedQuantity

decimal

SalesReturnDelivery Requested Quantity

 

X

 

 

 

The total quantity of the Commodity requested on the Sales Return Delivery (from associated sales orders).  

deliveredQuantity

decimal

SalesReturnDelivery Delivered Quantity

 

 

 

 

 

The total quantity of the Commodity delivered on the Sales Return Delivery.  

deliveryDiscountType

discountType

SalesReturnDelivery Delivery Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return Delivery (percent or amount). From the Trading Account or sales order.  

deliveryDiscountAmount

decimal

SalesReturnDelivery Delivery Discount Amount

 

X

 

 

 

Discount applicable to the Sales Return Delivery expressed as an amount. From the Trading Account or sales order.  

deliveryDiscountPercent

decimal

SalesReturnDelivery Delivery Discount Percent

 

X

 

 

 

Discount applicable to the Sales Return Delivery expressed as a percent. From the Trading Account or sales order.  

deliveryAdditionalDiscount1Type

discountType

SalesReturnDelivery Delivery Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return Delivery (percent or amount)  

deliveryAdditionalDiscount1Amount

decimal

SalesReturnDelivery Delivery Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Sales Return Delivery expressed as an amount.  

deliveryAdditionalDiscount1Percent

decimal

SalesReturnDelivery Delivery Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Sales Return Delivery expressed as a percent.  

deliveryAdditionalDiscount2Type

discountType

SalesReturnDelivery Delivery Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return Delivery (percent or amount)  

deliveryAdditionalDiscount2Amount

decimal

SalesReturnDelivery Delivery Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Sales Return Delivery expressed as an amount.  

deliveryAdditionalDiscount2Percent

decimal

SalesReturnDelivery Delivery Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Sales Return Delivery expressed as a percent.  

text1

string

SalesReturnDelivery Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Sales Return Delivery. Header text.  

text2

string

SalesReturnDelivery Text2

 

X

 

 

 

Further text/commentary for the Sales Return Delivery. Footer text.  

netTotal

decimal

SalesReturnDelivery Net Total

 

 

 

 

 

Total value of the Sales Return Delivery, including discounts, excluding tax. In Delivery currency.  

discountTotal

decimal

SalesReturnDelivery Discount Total

 

 

 

 

 

Total discounts applied to the Delivery. In Delivery currency.  

chargesTotal

decimal

SalesReturnDelivery Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Return Delivery (e.g. finance charges, interest). In Delivery currency.  

taxTotal

decimal

SalesReturnDelivery Tax Total

 

 

 

 

 

Total tax applicable to the Sales Return Delivery. In Delivery currency.  

grossTotal

decimal

SalesReturnDelivery Gross Total

 

 

 

 

 

Total value of the Sales Return Delivery, including tax & discounts & charges. In Delivery currency.  

costTotal

decimal

SalesReturnDelivery Cost Total

 

X

 

 

 

Total cost of the Sales Return Delivery. In Delivery currency.  

profitTotal

decimal

SalesReturnDelivery Profit Total

 

X

 

 

 

Total profit on the Sales Return Delivery (e.g. net total - cost total). In order currency.  

receipts

receipt*

SalesReturnDelivery Receipt

 

X

 

 

association 

Link to the Sales Return Delivery receipt(s) (if any). See Receipt definition.  

invoiceTradingAccount

tradingAccount

SalesReturnDelivery Invoice TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be invoiced for the Sales Return Delivery (if different from the Customer), e.g. Bill To. See TradingAccount definition.  

invoiceCountry

normalizedString

SalesReturnDelivery Invoice Country

 

X

 

 

 

Country to which the Sales Invoice delivery is sent (e.g. for taxation purposes). ISO 3166-1 alpha-2 country codes only  

deliveryCountry

normalizedString

SalesReturnDelivery Delivery Country

 

X

 

 

 

Country of destination for the Sales Return Delivery (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Delivery address?  

originCountry

normalizedString

SalesReturnDelivery Origin Country

 

X

 

 

 

Country of origin for the Sales Return Delivery (e.g. for intrastat purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Operating Company address?  

typeOfBusiness

normalizedString

SalesReturnDelivery Type Of Business

 

X

 

 

 

Type of Business for intrastat purposes. 

statisticalProcess

normalizedString

SalesReturnDelivery Statistical Process

 

X

 

 

 

Statistic method for intrastat purposes. 

user

normalizedString

SalesReturnDelivery User

 

X

 

 

 

The user responsible for the Sales Return Delivery, e.g. the person dispatching the Sales Order. The user resource will be defined in the future.  

cases

case*

SalesReturnDelivery Cases

 

X

 

 

association 

The reference of the case associated with the Sales Return Delivery, e.g. if the Case is for fault incurred during delivery. A Case entity has been defined to support the F2F process.  

financialAccounts

financialAccount*

SalesReturnDelivery FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Return Delivery. See FinancialAccount definition.  

costCentres

costCentre*

SalesReturnDelivery CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Return Delivery. See Cost Centre definition.  

departments

department*

SalesReturnDelivery Departments

 

X

 

 

association 

Department(s) associated with this Sales Return Delivery. See Department definition.  

interactions

interaction*

SalesReturnDelivery Interactions

 

X

 

 

association 

Interaction(s) associated with the Sales Return Delivery. See Interaction definition.  

notes

note*

SalesReturnDelivery Note

 

X

 

 

child 

Notes associated with a Sales Return Delivery. 

Top  

Resource salesReturnDeliveryLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

salesReturnDelivery

salesReturnDelivery

SalesReturnDeliveryLine SalesReturnDelivery

 

 

 

X

parent 

The Sales Return Delivery this Line belongs to. See SalesReturnDelivery definition.  

active

boolean

SalesReturnDeliveryLine Active Flag

 

 

 

 

 

Flag to indicate if the Sales Return Delivery Line is an active one. Default = True  

reference

normalizedString

SalesReturnDeliveryLine Reference

X

 

 

 

 

Reference for the Sales Return Delivery Line. 

reference2

normalizedString

SalesReturnDeliveryLine Reference2

 

X

 

 

 

Additional reference for the Sales Return Delivery Line.  

number

decimal

SalesReturnDeliveryLine Number

 

 

 

 

 

The number of the Sales Return Delivery Line. For sequencing and ordering of lines.  

status

salesReturnDeliveryStatus

SalesReturnDeliveryLine Status

 

X

 

 

 

Status of the Sales Return Delivery Line (e.g. Part, Complete).  

type

lineType

SalesReturnDeliveryLine Type

 

X

 

X

 

Enumerator indicating the type of Sales Return Delivery Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

commodity

commodity

SalesReturnDeliveryLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Sales Return Delivery Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

SalesReturnDeliveryLine Text

 

X

 

 

 

Text applicable to the Sales Return Delivery Line (e.g. the Line may be a comment Line or a free text Line). If the Sales Return Delivery Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

SalesReturnDeliveryLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Sales Return Delivery Line. See Variant definition.  

commodityDimension

commodityDimension

SalesReturnDeliveryLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity delivered on the Sales Return Delivery Line. See Dimension definition.  

fulfillmentLocation

location

SalesReturnDeliveryLine Fulfillment Location

 

X

 

 

reference 

The Location from which the Sales Return Delivery Line was fulfilled. See Location definition.  

fulfillmentSubLocation

location

SalesReturnDeliveryLine Fulfilment Sub-Location

 

X

 

 

reference 

The sub-Location from which the Sales Return Delivery Line was fulfilled. See Location definition.  

requestedDeliveryDate

date

SalesReturnDeliveryLine Requested Delivery Date

 

X

 

 

 

The requested date of the Delivery Line, from the Sales Order.  

actualDeliveryDate

date

SalesReturnDeliveryLine Actual Delivery Date

 

 

 

 

 

The actual date of the Sales Return Delivery Line.  

actualDeliveryTime

time

SalesReturnDeliveryLine Actual Delivery Time

 

X

 

 

 

The actual time of the Sales Return Delivery Line. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dateExceptionReason

string

SalesReturnDeliveryLine Date Exception Reason

 

X

 

 

 

A reason for the difference in Delivery dates for the Sales Return Delivery Line, if any.  

unitOfMeasure

unitOfMeasure

SalesReturnDeliveryLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

requestedQuantity

decimal

SalesReturnDeliveryLine Requested Quantity

 

X

 

 

 

The quantity of the Commodity requested on the Sales Return Delivery Line.  

deliveredQuantity

decimal

SalesReturnDeliveryLine Delivered Quantity

 

 

 

 

 

The quantity of the Commodity delivered on the Sales Return Delivery Line.  

initialPrice

decimal

SalesReturnDeliveryLine Initial Price

 

 

 

 

 

The initial price of the Commodity ordered on the Sales Return Delivery Line (e.g. before discounts). In Delivery currency.  

pricelist

priceList

SalesReturnDeliveryLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Sales Return Delivery Line. See PriceList definition.  

deliveryLineDiscountType

discountType

SalesReturnDeliveryLine Delivery Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Sales Return Delivery Line (percent or amount). From the trading account or sales order.  

deliveryLineDiscountAmount

decimal

SalesReturnDeliveryLine Delivery Line Discount Amount

 

X

 

 

 

Discount applicable to the Sales Return Delivery Line, expressed as an amount. From the trading account or sales order.  

deliveryLineDiscountPercent

decimal

SalesReturnDeliveryLine Delivery Line Discount Percent

 

X

 

 

 

Discount applicable to the Sales Return Delivery Line, expressed as a percentage. From the trading account or sales order.  

deliveryLineSubtotalDiscountType

discountType

SalesReturnDeliveryLine Delivery Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Sales Return Delivery Lines (percent or amount) of which this Line is part.  

deliveryLineSubtotalDiscountAmount

decimal

SalesReturnDeliveryLine Delivery Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Sales Return Delivery Line, expressed as an amount.  

deliveryLineSubtotalDiscountPercent

decimal

SalesReturnDeliveryLine Delivery Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Sales Return Delivery Line, expressed as a percentage.  

actualPrice

decimal

SalesReturnDeliveryLine Actual Price

 

 

 

 

 

The actual price of the Commodity ordered on the Sales Return Delivery Line (e.g. after discounts or adjustments). In Delivery currency.  

netTotal

decimal

SalesReturnDeliveryLine Net Total

 

 

 

 

 

Total value of the Sales Return Delivery Line, including discounts, excluding tax (e.g. quantity * actual price). In Delivery currency. Could be calculated.  

chargesTotal

decimal

SalesReturnDeliveryLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Sales Return Delivery Line (e.g. finance charges, interest). In Delivery currency.  

discountTotal

decimal

SalesReturnDeliveryLine Discount Total

 

 

 

 

 

Total discounts applied to the return delivery line. In delivery currency  

taxCodes

taxCode*

SalesReturnDeliveryLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Sales Return Delivery Line (default value from sales order). See TaxCode definition.  

priceTax

decimal

SalesReturnDeliveryLine Price Tax

 

X

 

 

 

Tax applicable to the Sales Return Delivery Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

SalesReturnDeliveryLine Tax Total

 

 

 

 

 

Tax applicable to the Sales Return Delivery Line. In Delivery currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

SalesReturnDeliveryLine Gross Total

 

 

 

 

 

Total value of the Sales Return Delivery Line, including discounts & tax & charges. In Delivery currency.  

costTotal

decimal

SalesReturnDeliveryLine Cost Total

 

X

 

 

 

Total cost of the Sales Return Delivery Line. In Delivery currency.  

profitTotal

decimal

SalesReturnDeliveryLine Profit Total

 

X

 

 

 

Total profit on the Sales Return Delivery Line (e.g. net total - cost total). In Delivery currency.  

receipts

receipt*

SalesReturnDeliveryLine Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Sales Order Line. See Receipt definition.  

financialAccounts

financialAccount*

SalesReturnDeliveryLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Sales Return Delivery Line. See FinancialAccount definition.  

costCentres

costCentre*

SalesReturnDeliveryLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Sales Return Delivery Line. See Cost Centre definition.  

departments

department*

SalesReturnDeliveryLine Departments

 

X

 

 

association 

Department(s) associated with this Sales Return Delivery Line. See Department definition.  

notes

note*

SalesReturnDeliveryLine Note

 

X

 

 

child 

Notes associated with a Sales Return Delivery Line.  

Top  

Resource purchaseOrder

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseOrder Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Order is an active one. Default = True  

reference

normalizedString

PurchaseOrder Reference

X

 

 

 

 

Reference for the Purchase Order. 

reference2

normalizedString

PurchaseOrder Reference2

 

X

 

 

 

Additional reference for the Purchase Order. 

status

purchaseOrderStatus

PurchaseOrder Status

 

X

 

 

 

Status of the Purchase Order 

statusFlag

boolean

PurchaseOrder Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. order on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

PurchaseOrder Status Flag Text

 

X

 

 

 

Purchase Order status flag text. Default = On Hold  

tradingAccount

tradingAccount

PurchaseOrder Supplier TradingAccount

 

 

 

 

reference 

Link to the Purchase Order Supplier trading account. See TradingAccount definition.  

customerTradingAccount

tradingAccount

PurchaseOrder Customer TradingAccount

 

X

 

 

reference 

Link to the Purchase Order Customer account (e.g. for back to back, contremarque, drop-ship ordering). See TradingAccount definition. These are also stored on PurchaseOrderLines  

customerReference

normalizedString

PurchaseOrder Customer Reference

 

X

 

 

 

Customer own reference for the Sales Order (e.g. for back to back, contremarque, drop-ship ordering).  

customerSalesOrders

salesOrder*

PurchaseOrder Customer SalesOrder

 

X

 

 

association 

Link to any Customer Sales Orders that this Purchase Order is fulfilling (back to back or drop-ship). See PurchaseOrder definition. These are also stored on PurchaseOrderLines  

supplierReference

normalizedString

PurchaseOrder Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Order (e.g. a SO number).  

pricelist

priceList

PurchaseOrder PriceList

 

X

 

 

reference 

Link to the Price List used when generating the Purchase Order. See PriceList definition.  

sellerContact

contact

PurchaseOrder Seller Contact

 

X

 

 

reference 

Link to the Contact at Supplier who took the Purchase Order. See Contact definition. Default = Primary TradingAccount Contact  

type

normalizedString

PurchaseOrder Type

 

X

 

 

 

The Purchase Order type. 

copyFlag

boolean

PurchaseOrder Copy Flag

 

 

 

 

 

Indicates if this Purchase Order is a copy or not. Default is false (no)  

originatorDocument

purchaseOrderOriginatorDocument--choice

PurchaseOrder Originator Document Reference

 

X

 

 

reference 

Reference to another Purchase Order if required (e.g. if order is a copy, then this will show which order was copied, if the order is from a blanket order, this will show the blanket order details). See PurchaseOrder definition.  

requisition

purchaseRequisition

PurchaseOrder Requisition

 

X

 

 

reference 

A link to the Requisition used to create this Purchase Order (if any). See PurchaseRequisitions definition. Must be a valid Requisition.  

postalAddresses

postalAddress*

PurchaseOrder PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the purchase order. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

PurchaseOrder Delivery Method

 

X

 

 

 

Delivery method to be employed for Purchase Order (e.g. Courier, Collection, etc)  

deliveryRule

boolean

PurchaseOrder Delivery Rule

 

X

 

 

 

Flag to indicate if the order has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryTerms

normalizedString

PurchaseOrder Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

PurchaseOrder Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

PurchaseOrder Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Purchase Order. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

PurchaseOrder Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Order. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseOrder Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Order currency.  

carrierTaxPrice

decimal

PurchaseOrder Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Order currency. 

carrierTotalPrice

decimal

PurchaseOrder Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Order currency.  

carrierPurchaseInvoices

purchaseInvoice*

PurchaseOrder Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery from the Supplier. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

PurchaseOrder Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this purchase order. See TaxCode definition.  

carrierReference

normalizedString

PurchaseOrder Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

PurchaseOrder Currency

 

 

 

 

 

The currency of the Purchase Order (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

PurchaseOrder OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseOrder OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Order Currency into Purchase Order OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseOrder OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Order Currency to Purchase Order OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Order Values in Purchase Order Currency / Purchase Order Operating Company Currency Exchange Rate = Purchase Order Values in Purchase Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseOrder OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Order Currency to Purchase Order OperatingCompany Currency, if different. Default = System date  

invoiceCurrency

normalizedString

PurchaseOrder Invoice Currency

 

X

 

 

 

The currency to be used on invoices associated with this order. ISO 4217. Could be derived from order currency.  

invoiceCurrencyExchangeRate

decimal

PurchaseOrder Invoice Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Order Currency into Purchase Order Invoice Currency, if different.  

invoiceCurrencyExchangeRateOperator

rateOperator

PurchaseOrder Invoice Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Order Currency to Purchase Order Invoice Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Order Values in Purchase Order Currency / Purchase Order Invoice Currency Exchange Rate = Purchase Order Values in Purchase Order Invoice Currency.  

invoiceCurrencyExchangeRateDate

date

PurchaseOrder Invoice Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Order Currency to Purchase Order Invoice Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseOrder Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Purchase Order. ISO 4217. Could be derived from order currency.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseOrder Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Order currency into the Supplier Trading Account currency, if different.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseOrder Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Order Currency to Purchase Order Supplier Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Order Values in Purchase Order Currency / Purchase Order Supplier TradingAccount Currency Exchange Rate = Purchase Order Values in Purchase Order Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseOrder Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Order Currency to Supplier Trading Account Currency, if different. Default = System date  

date

date

PurchaseOrder Date

 

 

 

 

 

Date the Purchase Order was placed. 

time

time

PurchaseOrder Time

 

X

 

 

 

Time the Purchase Order was placed. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

validity

decimal

PurchaseOrder Validity

 

X

 

 

 

Period the Purchase Order is valid for (days from Order Date).  

expirationDate

date

PurchaseOrder Expiration Date

 

X

 

 

 

The expiration date of the Purchase Order (PurchaseOrder Date + Validity).  

dueDate

date

PurchaseOrder Due Date

 

X

 

 

 

Date the Purchase Order is due. 

taxCodes

taxCode*

PurchaseOrder Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Order. See TaxCode definition.  

user

normalizedString

PurchaseOrder User

 

X

 

 

 

Link to the user who placed the Purchase Order. The user resource will be defined in the future.  

buyerUser

normalizedString

PurchaseOrder Buyer

 

X

 

 

 

Link to the user who will be the buyer for this Purchase Order. The user resource will be defined in the future.  

purchaseOrderLines

purchaseOrderLine*

PurchaseOrder PurchaseOrderLine

 

 

 

 

child 

Purchase Order Line detail (e.g. items on the Purchase Order). See PurchaseOrderLine definition.  

lineCount

decimal

PurchaseOrder Line Count

 

 

 

 

 

The number of lines on the Purchase Order. Should be auto-populated. Used as a cross reference to ensure order integrity.  

orderDiscountType

discountType

PurchaseOrder Order Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Order (percent or amount). From the Trading Account.  

orderDiscountAmount

decimal

PurchaseOrder Order Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Order expressed as an amount. From the Trading Account.  

orderDiscountPercent

decimal

PurchaseOrder Order Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Order expressed as a percent. From the Trading Account.  

orderAdditionalDiscount1Type

discountType

PurchaseOrder Order Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase order (percent or amount)  

orderAdditionalDiscount1Amount

decimal

PurchaseOrder Order Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Purchase order expressed as an amount.  

orderAdditionalDiscount1Percent

decimal

PurchaseOrder Order Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Purchase order expressed as a percent.  

orderAdditionalDiscount2Type

discountType

PurchaseOrder Order Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase order (percent or amount)  

orderAdditionalDiscount2Amount

decimal

PurchaseOrder Order Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Purchase order expressed as an amount.  

orderAdditionalDiscount2Percent

decimal

PurchaseOrder Order Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Purchase order expressed as a percent.  

text1

string

PurchaseOrder Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Order. Header text.  

text2

string

PurchaseOrder Text2

 

X

 

 

 

Further text/commentary for the Purchase Order. Footer text.  

netTotal

decimal

PurchaseOrder Net Total

 

 

 

 

 

Total value of the Purchase Order, including discounts, excluding tax. In order currency.  

discountTotal

decimal

PurchaseOrder Discount Total

 

 

 

 

 

Total discounts applied to the order. In order currency  

chargesTotal

decimal

PurchaseOrder Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Order (e.g. finance charges, interest). In order currency.  

taxTotal

decimal

PurchaseOrder Tax Total

 

 

 

 

 

Total tax applicable to the Purchase Order. In order currency.  

grossTotal

decimal

PurchaseOrder Gross Total

 

 

 

 

 

Total value of the Purchase Order, including tax & discounts & charges. In order currency.  

payments

payment*

PurchaseOrder Payment

 

X

 

 

association 

Link to the Purchase Order Payment (e.g. if Payment was made with order or if a deposit has been paid). See Payment definition.  

depositFlag

boolean

PurchaseOrder Deposit Flag

 

X

 

 

 

Flag to indicate if a deposit has been paid with the order. Default False (no deposit taken).  

contract

string

PurchaseOrder Contract

 

X

 

 

 

Reference to a contract associated with the Purchase Order (e.g. a blanket or call-off order).  

invoiceTradingAccount

tradingAccount

PurchaseOrder Invoice TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be invoiced for the Purchase Order (if different from the Supplier), e.g. Bill To. See TradingAccount definition.  

projects

project*

PurchaseOrder Project

 

X

 

 

association 

Identifier of the Project this Purchase Order is for. See Project definition.  

projectLines

projectLine*

PurchaseOrder ProjectLine

 

X

 

 

association 

Project Line value for this Purchase Order. See ProjectLine definition. Some applications may not have Project Lines.  

cases

case*

PurchaseOrder Cases

 

X

 

 

association 

The reference of the case associated with the Purchase Order, e.g. if the Order is for repair/fix services. A Case entity has been defined to support the F2F process.  

purchaseOrderDeliveries

purchaseOrderDelivery*

PurchaseOrder PurchaseOrderDelivery

 

X

 

 

association 

Link to the Delivery (receipt) against the Purchase Order. If there are multiple then these are held against the Purchase Order Line. See PurchaseOrderDelivery definition.  

financialAccounts

financialAccount*

PurchaseOrder FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Order. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseOrder CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Order. See Cost Centre definition.  

departments

department*

PurchaseOrder Departments

 

X

 

 

association 

Department(s) associated with this Purchase Order. See Department definition.  

interactions

interaction*

PurchaseOrder Interactions

 

X

 

 

association 

Interaction(s) associated with the purchase order. See Interaction definition.  

notes

note*

PurchaseOrder Note

 

X

 

 

child 

Notes associated with a Purchase Order. 

Top  

Resource purchaseOrderLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseOrder

purchaseOrder

PurchaseOrderLine Purchase Order

 

 

 

 

parent 

The parent PurchaseOrder 

active

boolean

PurchaseOrderLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Order Line is an active one. Default = True  

reference

normalizedString

PurchaseOrderLine Reference

X

 

 

 

 

Reference for the Purchase Order Line. 

reference2

normalizedString

PurchaseOrderLine Reference2

 

X

 

 

 

Additional reference for the Purchase Order Line. 

number

decimal

PurchaseOrderLine Number

 

 

 

 

 

The number of the Purchase Order Line. For sequencing and ordering of lines.  

status

purchaseOrderStatus

PurchaseOrderLine Status

 

X

 

 

 

Status of the Purchase Order Line. 

type

lineType

PurchaseOrderLine Type

 

X

 

X

 

Enumerator indicating the type of Purchase Order Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

deliveryTerms

normalizedString

PurchaseOrderLine Delivery Terms

 

X

 

 

 

The terms for Delivery for this Purchase Order Line. Also on Purchase Order.  

deliveryDate

date

PurchaseOrderLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

dueDate

date

PurchaseOrderLine Due Date

 

X

 

 

 

Date the Purchase Order Line is due. Delivery date may be different to the due date.  

carrierTradingAccount

tradingAccount

PurchaseOrderLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Order Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseOrderLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Order currency.  

carrierTaxPrice

decimal

PurchaseOrderLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Order currency. 

carrierTotalPrice

decimal

PurchaseOrderLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Order currency.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

PurchaseOrderLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery from the Supplier. See PurchaseInvoiceLine definition.  

carrierTaxCodes

taxCode*

PurchaseOrderLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Purchase Order Line. See TaxCode definition.  

carrierReference

normalizedString

PurchaseOrderLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

commodity

commodity

PurchaseOrderLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Order Line. See Commodity definition. Not mandatory as Line may be a comment or free text Line.  

text

string

PurchaseOrderLine Text

 

X

 

 

 

Text applicable to the Purchase Order Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Order Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseOrderLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the purchase order Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseOrderLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity ordered on the purchase order Line. See Dimension definition.  

commodityIdentifier

commodityIdentifier

PurchaseOrderLine Commodity Identifier

 

X

 

 

reference 

Link to the Commodity Identifier(s) for this Purchase Order Line, if it is traced to that level of detail.  

fulfillmentLocation

location

PurchaseOrderLine Fulfillment Location

 

X

 

 

reference 

The Location to which the Purchase Order Line will be delivered (e.g. the warehouse receiving the Commodity). See Location definition.  

unitOfMeasure

unitOfMeasure

PurchaseOrderLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

PurchaseOrderLine Quantity

 

 

 

X

 

The quantity of the Commodity ordered on the Purchase Order Line.  

initialPrice

decimal

PurchaseOrderLine Initial Price

 

 

 

 

 

The initial price of the Commodity ordered on the Purchase Order Line (e.g. before discounts). In order currency.  

pricelist

priceList

PurchaseOrderLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Purchase Order Line. See PriceList definition.  

customerTradingAccount

tradingAccount

PurchaseOrderLine Customer TradingAccount

 

X

 

 

reference 

Link to the Sales Order Line Customer account (e.g. for back to back, contremarque, drop-ship ordering). See TradingAccount definition.  

customerReference

normalizedString

PurchaseOrderLine Customer Reference

 

X

 

 

 

Customer own reference for the Purchase Order Line.  

customerSalesOrders

salesOrder*

PurchaseOrderLine Customer SalesOrders

 

X

 

 

association 

Link to any Customer Sales Orders this Purchase Order Line is fulfilling (back to back or drop-ship). See SalesOrder definition.  

customerSalesOrderLines

salesOrderLine*

PurchaseOrderLine Customer SalesOrderLines

 

X

 

 

association 

Link to any Customer Sales Order Lines this Purchase Order Line is fulfilling (back to back or drop-ship). See SalesOrderLine definition.  

orderLineDiscountType

discountType

PurchaseOrderLine Order Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Order Line (percent or amount). From the Purchase Order.  

orderLineDiscountAmount

decimal

PurchaseOrderLine Order Line Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Order Line, expressed as an amount. From the Purchase Order.  

orderLineDiscountPercent

decimal

PurchaseOrderLine Order Line Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Order Line, expressed as a percentage. From the Purchase Order.  

orderLineSubtotalDiscountType

discountType

PurchaseOrderLine Order Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Purchase Order Lines (percent or amount) of which this Line is part.  

orderLineSubtotalDiscountAmount

decimal

PurchaseOrderLine Order Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Order Line, expressed as an amount.  

orderLineSubtotalDiscountPercent

decimal

PurchaseOrderLine Order Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Order Line, expressed as a percentage.  

actualPrice

decimal

PurchaseOrderLine Actual Price

 

 

 

 

 

The actual price of the Commodity ordered on the Purchase Order Line (e.g. after discounts or adjustments). In order currency.  

netTotal

decimal

PurchaseOrderLine Net Total

 

 

 

 

 

Total value of the Purchase Order Line, including discounts, excluding tax (e.g. quantity * actual price). In order currency. Could be calculated.  

discountTotal

decimal

PurchaseOrderLine Discount Total

 

 

 

 

 

Total discounts applied to the order line. In order currency  

chargesTotal

decimal

PurchaseOrderLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Order Line (e.g. finance charges, interest, landed costs). In order currency.  

fobPoint

string

PurchaseOrderLine FOB Point

 

X

 

 

 

The FOB point applicable to the Purchase Order Line. FOB is an abbreviation for Free On Board. The term FOB is used when shipping goods, to indicate who pays loading and transportation costs, and/or the point at which the responsibility of the goods transfers from shipper to buyer  

taxCodes

taxCode*

PurchaseOrderLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Order Line (default value from Purchase Order). See TaxCode definition.  

priceTax

decimal

PurchaseOrderLine Price Tax

 

X

 

 

 

Tax applicable to the Purchase Order Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

PurchaseOrderLine Tax Total

 

 

 

 

 

Tax applicable to the Purchase Order Line. In order currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

PurchaseOrderLine Gross Total

 

 

 

 

 

Total value of the Purchase Order Line, including discounts & tax & charges. In order currency.  

project

project

PurchaseOrderLine Project

 

X

 

 

reference 

Identifier of the Project this Purchase Order Line is for. See Project definition. Could default from Purchase Order  

projectLine

projectLine

PurchaseOrderLine ProjectLine

 

X

 

 

reference 

Project Line value for this Purchase Order Line. See ProjectLine definition. Could default from Purchase Order. Some applications may not have Project Lines.  

purchaseOrderDeliveryLines

purchaseOrderDeliveryLine*

PurchaseOrderLine PurchaseOrderDeliveryLines

 

X

 

 

association 

Link to the Delivery (receipt) Line against the Purchase Order Line. See PurchaseOrderDeliveryLine definition.  

purchaseInvoiceLines

purchaseInvoiceLine*

PurchaseOrderLine PurchaseInvoiceLine

 

X

 

 

association 

Purchase Invoice Line(s) associated with the Purchase Order Line. See PurchaseInvoiceLine definition.  

payments

payment*

PurchaseOrderLine Payment

 

X

 

 

association 

A link to the (cash) payment(s) associated with this Purchase Order Line. See Payment definition.  

paymentLines

paymentLine*

PurchaseOrderLine PaymentLine

 

X

 

 

association 

A link to the (cash) payment line(s) associated with this Purchase Order Line. See PaymentLine definition.  

financialAccounts

financialAccount*

PurchaseOrderLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Order Line. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseOrderLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Order Line. See Cost Centre definition.  

departments

department*

PurchaseOrderLine Departments

 

X

 

 

association 

Department(s) associated with this Purchase Order Line. See Department definition.  

notes

note*

PurchaseOrderLine Note

 

X

 

 

child 

Notes associated with a Purchase Order Line. 

Top  

Resource purchaseRequisition

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseRequisition Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Requisition is an active one. Default = True  

reference

normalizedString

PurchaseRequisition Reference

X

 

 

 

 

Reference for the Purchase Requisition. 

reference2

normalizedString

PurchaseRequisition Reference2

 

X

 

 

 

Additional reference for the Purchase Requisition.  

status

purchaseRequisitionStatus

PurchaseRequisition Status

 

X

 

 

 

Status of the Purchase Requisition 

statusFlag

boolean

PurchaseRequisition Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Requisition on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

PurchaseRequisition Status Flag Text

 

X

 

 

 

Purchase Requisition status flag text. Default = On Hold  

tradingAccount

tradingAccount

PurchaseRequisition Supplier TradingAccount

 

X

 

 

reference 

Link to the Purchase Requisition Supplier trading account. See TradingAccount definition.  

sellerContact

contact

PurchaseRequisition Seller Contact

 

X

 

 

reference 

Link to the Contact at Supplier who is handling the Purchase Quotation. See Contact definition. Default = Primary TradingAccount Contact  

supplierReference

normalizedString

PurchaseRequisition Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Requisition (e.g. a SO number).  

pricelist

priceList

PurchaseRequisition PriceList

 

X

 

 

reference 

Link to the Price List used when generating the Purchase Requisition See PriceList definition.  

customerTradingAccount

tradingAccount

PurchaseRequisition Customer TradingAccount

 

X

 

 

reference 

Link to the Purchase Requisition Customer trading account (e.g. if PO is for direct Delivery / drop ship to a Customer). See TradingAccount definition.  

customerReference

normalizedString

PurchaseRequisition Customer Reference

 

X

 

 

 

Customer own reference for the Purchase Requisition.  

type

normalizedString

PurchaseRequisition Type

 

X

 

 

 

The Purchase Requisition type. 

copyFlag

boolean

PurchaseRequisition Copy Flag

 

 

 

 

 

Indicates if this Purchase Requisition is a copy or not. Default is false (no)  

originatorDocument

purchaseRequisitionOriginatorDocument--choice

PurchaseRequisition Originator Document Reference

 

X

 

 

reference 

Reference to another Purchase Requisition if required (e.g. if Requisition is a copy, then this will show which Requisition was copied, if the Requisition is from a blanket Requisition, this will show the blanket Requisition details). See PurchaseOrder definition.  

postalAddresses

postalAddress*

PurchaseRequisition PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Purchase Requisition. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryTerms

normalizedString

PurchaseRequisition Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

PurchaseRequisition Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

currency

normalizedString

PurchaseRequisition Currency

 

 

 

 

 

The currency of the Purchase Requisition (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

PurchaseRequisition OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseRequisition OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Requisition Currency into Purchase Requisition OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseRequisition OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Requisition Currency to Purchase Requisition OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Requisition Values in Purchase Requisition Currency / Purchase Requisition Operating Company Currency Exchange Rate = Purchase Requisition Values in Purchase Requisition OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseRequisition OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Requisition Currency to Purchase Requisition OperatingCompany Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseRequisition Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Purchase Requisition. ISO 4217. Could be derived from Requisition currency.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseRequisition Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Requisition currency into the Supplier Trading Account currency, if different.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseRequisition Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Requisition Currency to Purchase Requisition Supplier Trading Account Currency * (multiplication) or / division. E.g. if the operator is division then it is Purchase Requisition Values in Purchase Requisition Currency / Purchase Requisition Supplier TradingAccount Currency Exchange Rate = Purchase Requisition Values in Purchase Requisition Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseRequisition Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Requisition Currency to Supplier Trading Account Currency, if different. Default = System date  

date

date

PurchaseRequisition Date

 

 

 

 

 

Date the Purchase Requisition was placed. 

time

time

PurchaseRequisition Time

 

X

 

 

 

Time the Purchase Requisition was placed. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

validity

decimal

PurchaseRequisition Validity

 

X

 

 

 

Period the Purchase Requisition is valid for (days from Requisition Date).  

expirationDate

date

PurchaseRequisition Expiration Date

 

X

 

 

 

The expiration date of the Purchase Requisition (PurchaseRequisition Date + Validity).  

dueDate

date

PurchaseRequisition Due Date

 

X

 

 

 

Date the Purchase Requisition is due. 

taxCodes

taxCode*

PurchaseRequisition Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Requisition. See TaxCode definition.  

user

normalizedString

PurchaseRequisition User

 

X

 

 

 

Link to the user who placed the Purchase Requisition. The user resource will be defined in the future.  

buyerUser

normalizedString

PurchaseRequisition Buyer

 

X

 

 

 

Link to the user who will be the buyer for this Purchase Requisition. The user resource will be defined in the future.  

purchaseRequisitionLines

purchaseRequisitionLine*

PurchaseRequisition Line

 

 

 

 

child 

Purchase Requisition Line detail (e.g. items on the Purchase Requisition). See PurchaseRequisitionLine definition.  

lineCount

decimal

PurchaseRequisition Line Count

 

 

 

 

 

The number of lines on the Purchase Requisition. Should be auto-populated. Used as a cross reference to ensure Requisition integrity.  

orderDiscountType

discountType

PurchaseRequisition Order Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Requisition (percent or amount). From the Trading Account.  

orderDiscountAmount

decimal

PurchaseRequisition Order Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Requisition expressed as an amount. From the Trading Account.  

orderDiscountPercent

decimal

PurchaseRequisition Order Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Requisition expressed as a percent. From the Trading Account.  

orderAdditionalDiscount1Type

discountType

PurchaseRequisition Order Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Requisition (percent or amount)  

orderAdditionalDiscount1Amount

decimal

PurchaseRequisition Order Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Purchase Requisition expressed as an amount.  

orderAdditionalDiscount1Percent

decimal

PurchaseRequisition Order Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Purchase Requisition expressed as a percent.  

orderAdditionalDiscount2Type

discountType

PurchaseRequisition Order Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Requisition (percent or amount)  

orderAdditionalDiscount2Amount

decimal

PurchaseRequisition Order Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Purchase Requisition expressed as an amount.  

orderAdditionalDiscount2Percent

decimal

PurchaseRequisition Order Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Purchase Requisition expressed as a percent.  

text1

string

PurchaseRequisition Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Requisition. Header text.  

text2

string

PurchaseRequisition Text2

 

X

 

 

 

Further text/commentary for the Purchase Requisition. Footer text.  

netTotal

decimal

PurchaseRequisition Net Total

 

 

 

 

 

Total value of the Purchase Requisition, including discounts, excluding tax. In Requisition currency.  

discountTotal

decimal

PurchaseRequisition Discount Total

 

 

 

 

 

Total discounts applied to the Requisition. In Requisition currency  

chargesTotal

decimal

PurchaseRequisition Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Requisition (e.g. finance charges, interest). In Requisition currency.  

taxTotal

decimal

PurchaseRequisition Tax Total

 

 

 

 

 

Total tax applicable to the Purchase Requisition. In Requisition currency.  

grossTotal

decimal

PurchaseRequisition Gross Total

 

 

 

 

 

Total value of the Purchase Requisition, including tax & discounts & charges. In Requisition currency.  

contract

string

PurchaseRequisition Contract

 

X

 

 

 

Reference to a contract associated with the Purchase Requisition (e.g. a blanket or call-off Requisition).  

projects

project*

PurchaseRequisition Project

 

X

 

 

association 

Identifier of the Project this Purchase Requisition is for. See Project definition.  

projectLines

projectLine*

PurchaseRequisition ProjectLine

 

X

 

 

association 

Project Line value for this Purchase Requisition. See ProjectLine definition. Some applications may not have Project Lines.  

financialAccounts

financialAccount*

PurchaseRequisition FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Requisition. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseRequisition CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Requisition. See Cost Centre definition.  

departments

department*

PurchaseRequisition Departments

 

X

 

 

association 

Department(s) associated with this Purchase Requisition. See Department definition.  

interactions

interaction*

PurchaseRequisition Interactions

 

X

 

 

association 

Interaction(s) associated with the Purchase Requisition. See Interaction definition.  

notes

note*

PurchaseRequisition Note

 

X

 

 

child 

Notes associated with a Purchase Requisition. 

Top  

Resource purchaseRequisitionLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseRequisition

purchaseRequisition

PurchaseRequisitionLine Purchase Requisition

 

 

 

 

parent 

The parent PurchaseRequisition 

active

boolean

PurchaseRequisitionLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Requisition Line is an active one. Default = True  

reference

normalizedString

PurchaseRequisitionLine Reference

X

 

 

 

 

Reference for the Purchase Requisition Line. 

reference2

normalizedString

PurchaseRequisitionLine Reference2

 

X

 

 

 

Additional reference for the Purchase Requisition Line.  

number

decimal

PurchaseRequisitionLine Number

 

 

 

 

 

The number of the Purchase Requisition Line. For sequencing and ordering of lines.  

status

purchaseRequisitionLineStatus

PurchaseRequisitionLine Status

 

X

 

 

 

Status of the Purchase Requisition Line. 

type

lineType

PurchaseRequisitionLine Type

 

X

 

X

 

Enumerator indicating the type of Purchase Requisition Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

deliveryTerms

normalizedString

PurchaseRequisitionLine Delivery Terms

 

X

 

 

 

The terms for Delivery for this Purchase Requisition Line. Also on Purchase Requisition.  

deliveryDate

date

PurchaseRequisitionLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

dueDate

date

PurchaseRequisitionLine Due Date

 

X

 

 

 

Date the Purchase Requisition Line is due. Delivery date may be different to the due date.  

commodity

commodity

PurchaseRequisitionLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Requisition Line. See Commodity definition. Not mandatory as Line may be a comment or free text Line.  

text

string

PurchaseRequisitionLine Text

 

X

 

 

 

Text applicable to the Purchase Requisition Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Requisition Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseRequisitionLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Purchase Requisition Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseRequisitionLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity ordered on the Purchase Requisition Line. See Dimension definition.  

fulfillmentLocation

location

PurchaseRequisitionLine Fulfillment Location

 

X

 

 

reference 

The Location to which the Purchase Requisition Line will be delivered (e.g. the warehouse receiving the Commodity). See Location definition.  

unitOfMeasure

unitOfMeasure

PurchaseRequisitionLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

PurchaseRequisitionLine Quantity

 

 

 

X

 

The quantity of the Commodity ordered on the Purchase Requisition Line.  

initialPrice

decimal

PurchaseRequisitionLine Initial Price

 

 

 

 

 

The initial price of the Commodity ordered on the Purchase Requisition Line (e.g. before discounts). In Requisition currency.  

pricelist

priceList

PurchaseRequisitionLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Purchase Requisition Line. See PriceList definition.  

orderLineDiscountType

discountType

PurchaseRequisitionLine Order Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Requisition Line (percent or amount). From the Purchase Requisition.  

orderLineDiscountAmount

decimal

PurchaseRequisitionLine Order Line Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Requisition Line, expressed as an amount. From the Purchase Requisition.  

orderLineDiscountPercent

decimal

PurchaseRequisitionLine Order Line Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Requisition Line, expressed as a percentage. From the Purchase Requisition.  

orderLineSubtotalDiscountType

discountType

PurchaseRequisitionLine Order Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Purchase Requisition Lines (percent or amount) of which this Line is part.  

orderLineSubtotalDiscountAmount

decimal

PurchaseRequisitionLine Order Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Requisition Line, expressed as an amount.  

orderLineSubtotalDiscountPercent

decimal

PurchaseRequisitionLine Order Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Requisition Line, expressed as a percentage.  

actualPrice

decimal

PurchaseRequisitionLine Actual Price

 

 

 

 

 

The actual price of the Commodity ordered on the Purchase Requisition Line (e.g. after discounts or adjustments). In Requisition currency.  

netTotal

decimal

PurchaseRequisitionLine Net Total

 

 

 

 

 

Total value of the Purchase Requisition Line, including discounts, excluding tax (e.g. quantity * actual price). In Requisition currency. Could be calculated.  

chargesTotal

decimal

PurchaseRequisitionLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Requisition Line (e.g. finance charges, interest, landed costs). In Requisition currency.  

taxCodes

taxCode*

PurchaseRequisitionLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Requisition Line (default value from Purchase Requisition). See TaxCode definition.  

priceTax

decimal

PurchaseRequisitionLine Price Tax

 

X

 

 

 

Tax applicable to the Purchase Requisition Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

PurchaseRequisitionLine Tax Total

 

 

 

 

 

Tax applicable to the Purchase Requisition Line. In Requisition currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

PurchaseRequisitionLine Gross Total

 

 

 

 

 

Total value of the Purchase Requisition Line, including discounts & tax & charges. In order currency.  

project

project

PurchaseRequisitionLine Project

 

X

 

 

reference 

Identifier of the Project this Purchase Requisition Line is for. See Project definition. Could default from Purchase Requisition  

projectLine

projectLine

PurchaseRequisitionLine ProjectLine

 

X

 

 

reference 

Project Line value for this Purchase Requisition Line. See ProjectLine definition. Could default from Purchase Requisition. Some applications may not have Project Lines.  

financialAccounts

financialAccount*

PurchaseRequisitionLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Requisition Line. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseRequisitionLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Requisition Line. See Cost Centre definition.  

departments

department*

PurchaseRequisitionLine Departments

 

X

 

 

association 

Department(s) associated with this Purchase Requisition Line. See Department definition.  

notes

note*

PurchaseRequisitionLine Note

 

X

 

 

child 

Notes associated with a Purchase Requisition Line.  

Top  

Resource purchaseInvoice

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseInvoice Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Invoice is an active one. Default = True  

reference

normalizedString

PurchaseInvoice Reference

X

 

 

 

 

Reference for the Purchase Invoice. 

reference2

normalizedString

PurchaseInvoice Reference2

 

X

 

 

 

Additional reference for the Purchase Invoice. 

status

purchaseInvoiceStatus

PurchaseInvoice Status

 

X

 

 

 

Status of the Purchase Invoice (e.g. approved, etc).  

statusFlag

boolean

PurchaseInvoice Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Invoice on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

PurchaseInvoice Status Flag Text

 

X

 

 

 

Purchase Invoice status flag text. Default = On Hold  

type

normalizedString

PurchaseInvoice Type

 

X

 

 

 

Type of Purchase Invoice. 

tradingAccount

tradingAccount

PurchaseInvoice Supplier TradingAccount

 

 

 

 

reference 

Link to the Supplier trading account. See TradingAccount definition.  

contact

contact

PurchaseInvoice Contact

 

X

 

 

reference 

Link to the Contact at Supplier who is handling the Purchase Invoice. See Contact definition. Default = Primary TradingAccount Contact  

supplierReference

normalizedString

PurchaseInvoice Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Invoice (e.g. SO number).  

pricelist

priceList

PurchaseInvoice PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Purchase Invoice. See PriceList definition.  

copyFlag

boolean

PurchaseInvoice Copy Flag

 

 

 

 

 

Indicates if this Purchase Invoice is a copy or not. Default is false (no)  

date

date

PurchaseInvoice Date

 

 

 

 

 

Date the Purchase Invoice was raised. 

time

time

PurchaseInvoice Time

 

X

 

 

 

Time the Purchase Invoice was raised. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

taxDate

date

PurchaseInvoice Tax Date

 

 

 

 

 

Used to indicate the point at which tax becomes applicable. Can default to Invoice date.  

taxCodes

taxCode*

PurchaseInvoice Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this purchase Invoice. See TaxCode definition.  

postalAddresses

postalAddress*

PurchaseInvoice PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the purchase Invoice. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

PurchaseInvoice Delivery Method

 

X

 

 

 

Delivery method to be employed for the Purchase Invoice (e.g. Courier, Collection, etc)  

deliveryRule

boolean

PurchaseInvoice Delivery Rule

 

X

 

 

 

Flag to indicate if the order has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryTerms

normalizedString

PurchaseInvoice Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

PurchaseInvoice Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

PurchaseInvoice Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Purchase Invoice. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

PurchaseInvoice Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Invoice. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseInvoice Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Invoice currency.  

carrierTaxPrice

decimal

PurchaseInvoice Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Invoice currency.  

carrierTotalPrice

decimal

PurchaseInvoice Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Invoice currency.  

carrierPurchaseInvoices

purchaseInvoice*

PurchaseInvoice Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery from the Supplier. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

PurchaseInvoice Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this purchase Invoice. See TaxCode definition.  

carrierReference

normalizedString

PurchaseInvoice Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

PurchaseInvoice Currency

 

 

 

 

 

The currency (e.g. GBP, USD, EUR) used on the Purchase Invoice. ISO 4217.  

operatingCompanyCurrency

normalizedString

PurchaseInvoice OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseInvoice OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Invoice Currency into Purchase Invoice OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseInvoice OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Invoice Currency to Purchase Invoice OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Invoice Values in Purchase Invoice Currency / Purchase Invoice Operating Company Currency Exchange Rate = Purchase Invoice Values in Purchase Invoice OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseInvoice OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Invoice Currency to Purchase Invoice OperatingCompany Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseInvoice Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Purchase Invoice. ISO 4217.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseInvoice Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Invoice currency into the Supplier Trading Account currency.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseInvoice Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Invoice Currency to Purchase Invoice Supplier Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Invoice Values in Purchase Invoice Currency / Purchase Invoice Supplier TradingAccount Currency Exchange Rate = Purchase Invoice Values in Purchase Invoice Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseInvoice Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Invoice Currency to Supplier Trading Account Currency, if different. Default = System date  

user

normalizedString

PurchaseInvoice User

 

X

 

 

 

Link to the user who the Purchase Invoice is for. The user resource will be defined in the future.  

purchaseInvoiceLines

purchaseInvoiceLine*

PurchaseInvoice PurchaseInvoiceLine

 

 

 

 

child 

Purchase Invoice Line detail. See PurchaseInvoiceLine definition.  

lineCount

decimal

PurchaseInvoice Line Count

 

 

 

 

 

The number of lines on the Purchase Invoice. Should be auto-populated. Used as a cross reference to ensure Invoice integrity.  

originatorDocuments

purchaseInvoiceOriginatorDocument*

PurchaseInvoice Originator Document References

 

X

 

 

association 

Reference to other documents (e.g. the purchase order associated with the Invoice). Could also include a link to the original Purchase Invoice if an Invoice is cancelled (reversed).  

purchaseOrderDeliveries

purchaseOrderDelivery*

PurchaseInvoice PurchaseOrderDeliveries

 

X

 

 

association 

A link to the Purchase Order Delivery associated with this Invoice. See PurchaseOrderDelivery definition.  

payments

payment*

PurchaseInvoice Payment

 

X

 

 

association 

A link to the (cash) payment(s) associated with this Purchase Invoice See Payment definition.  

contract

string

PurchaseInvoice Contract

 

X

 

 

 

Reference to a contract associated with the Purchase Invoice.  

settlementDiscountType

discountType

PurchaseInvoice Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Purchase Invoice (percent or amount). From the Trading Account.  

settlementDiscountAmount

decimal

PurchaseInvoice Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Invoice if the Purchase Invoice is paid within a certain timeframe, expressed as an amount. From the Trading Account.  

settlementDiscountPercent

decimal

PurchaseInvoice Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Invoice if the Purchase Invoice is paid within a certain timeframe, expressed as a percentage. From the Trading Account.  

settlementDiscountTerms

normalizedString

PurchaseInvoice Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Trading Account.  

settlementDiscountIncludedInTotal

boolean

PurchaseInvoice Settlement Discount Included In Total

 

X

 

 

 

Flag to indicate if settlement discount is included in Invoice Totals Default = False  

invoiceDiscountType

discountType

PurchaseInvoice Invoice Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Purchase Invoice (percent or amount). From the Trading Account.  

invoiceDiscountAmount

decimal

PurchaseInvoice Invoice Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Purchase Invoice, expressed as an amount. From the Trading Account.  

invoiceDiscountPercent

decimal

PurchaseInvoice Invoice Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Purchase Invoice, expressed as a percentage. From the Trading Account.  

invoiceAdditionalDiscount1Type

discountType

PurchaseInvoice Invoice Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Invoice (percent or amount)  

invoiceAdditionalDiscount1Amount

decimal

PurchaseInvoice Invoice Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Purchase Invoice expressed as an amount.  

invoiceAdditionalDiscount1Percent

decimal

PurchaseInvoice Invoice Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Purchase Invoice expressed as a percent.  

invoiceAdditionalDiscount2Type

discountType

PurchaseInvoice Invoice Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Invoice (percent or amount)  

invoiceAdditionalDiscount2Amount

decimal

PurchaseInvoice Invoice Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Purchase Invoice expressed as an amount.  

invoiceAdditionalDiscount2Percent

decimal

PurchaseInvoice Invoice Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Purchase Invoice expressed as a percent.  

netTotal

decimal

PurchaseInvoice Net Total

 

 

 

 

 

Total value of the Purchase Invoice, including discounts, excluding tax. In Purchase Invoice currency.  

discountTotal

decimal

PurchaseInvoice Discount Total

 

 

 

 

 

Total discounts applied to the Purchase Invoice. In Purchase Invoice currency.  

chargesTotal

decimal

PurchaseInvoice Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Invoice (e.g. finance charges, interest, landed costs). In Purchase Invoice currency.  

taxTotal

decimal

PurchaseInvoice Tax Total

 

 

 

 

 

Total tax applicable to the Purchase Invoice. In Purchase Invoice currency.  

grossTotal

decimal

PurchaseInvoice Gross Total

 

 

 

 

 

Total value of the Purchase Invoice, including tax & discounts & charges. In Purchase Invoice currency.  

dutyTotal

decimal

PurchaseInvoice Duty Total

 

X

 

 

 

Total value of (import) duty applicable to the Purchase Invoice  

text1

string

PurchaseInvoice Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Invoice. Header Text  

text2

string

PurchaseInvoice Text2

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Invoice. Footer Text  

projects

project*

PurchaseInvoice Project

 

X

 

 

association 

Identifier of the Project this Purchase Invoice is for. See Project definition.  

projectLines

projectLine*

PurchaseInvoice ProjectLine

 

X

 

 

association 

Project Line value for this Purchase Invoice. See ProjectLine definition. Some applications may not have Project Lines.  

cases

case*

PurchaseInvoice Cases

 

X

 

 

association 

The reference of the case associated with the Purchase Invoice e.g. if the Invoice is for repair/fix services. A Case entity has been defined to support the F2F process.  

financialAccounts

financialAccount*

PurchaseInvoice FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Invoice. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseInvoice CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Invoice. See Cost Centre definition.  

departments

department*

PurchaseInvoice Departments

 

X

 

 

association 

Department(s) associated with this Purchase Invoice. See Department definition.  

interactions

interaction*

PurchaseInvoice Interactions

 

X

 

 

association 

Interaction(s) associated with the purchase order. See Interaction definition.  

notes

note*

PurchaseInvoice Note

 

X

 

 

child 

Notes associated with a Purchase Invoice (e.g. credit control).  

Top  

Resource purchaseInvoiceLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseInvoice

purchaseInvoice

PurchaseInvoiceLine Purchase Invoice

 

 

 

 

parent 

The parent PurchaseInvoice 

active

boolean

PurchaseInvoiceLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Invoice Line is an active one. Default = True  

originatorDocumentLines

purchaseInvoiceLineOriginatorDocumentLine*

PurchaseInvoiceLine Originator Document Line References

 

X

 

 

association 

Reference to Lines on another document (e.g. the Purchase Order Line associated with the Invoice Line). Purchase Invoice Lines are often associated with Purchase Order Lines. Could also include a link to the original Invoice Line if an Invoice is cancelled (reversed).  

reference

normalizedString

PurchaseInvoiceLine Reference

X

 

 

 

 

Reference for the Purchase Invoice. 

reference2

normalizedString

PurchaseInvoiceLine Reference2

 

X

 

 

 

Additional reference for the Purchase Invoice. 

status

purchaseInvoiceLineStatus

PurchaseInvoiceLine Status

 

X

 

 

 

Status of the Purchase Invoice Line. 

type

lineType

PurchaseInvoiceLine Type

 

X

 

X

 

Enumerator indicating the type of Purchase Invoice Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

number

decimal

PurchaseInvoiceLine Number

 

 

 

 

 

The number of the Purchase Invoice Line. For sequencing and ordering of lines.  

commodity

commodity

PurchaseInvoiceLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Invoice Line (if any). See Commodity definition.  

text

string

PurchaseInvoiceLine Text

 

X

 

 

 

Text applicable to the Purchase Invoice Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Invoice Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseInvoiceLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the purchase Invoice Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseInvoiceLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the purchase Invoice Line. See Dimension definition.  

commodityIdentifier

commodityIdentifier

PurchaseInvoiceLine Commodity Identifier

 

X

 

 

reference 

Link to the Commodity Identifier(s) for this Purchase Invoice Line, if it is traced to that level of detail.  

deliveryDate

date

PurchaseInvoiceLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierTradingAccount

tradingAccount

PurchaseInvoiceLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Invoice Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseInvoiceLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Invoice currency.  

carrierTaxPrice

decimal

PurchaseInvoiceLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Invoice currency.  

carrierTotalPrice

decimal

PurchaseInvoiceLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Invoice currency.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

PurchaseInvoiceLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the Purchase Invoice Line charged by the carrier Company for the Delivery from the Supplier. See PurchaseInvoiceLine definition.  

carrierTaxCodes

taxCode*

PurchaseInvoiceLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Purchase Invoice Line. See TaxCode definition.  

carrierReference

normalizedString

PurchaseInvoiceLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

unitOfMeasure

unitOfMeasure

PurchaseInvoiceLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

PurchaseInvoiceLine Quantity

 

 

 

X

 

The quantity of the Purchase Invoice Line. Default to 1 if not used.  

initialPrice

decimal

PurchaseInvoiceLine Initial Price

 

 

 

 

 

The initial price of the Purchase Invoice Line (e.g. before discounts). In Purchase Invoice currency.  

pricelist

priceList

PurchaseInvoiceLine PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Purchase Invoice Line. See PriceList definition.  

settlementDiscountType

discountType

PurchaseInvoiceLine Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Purchase Invoice Line (percent or amount). From the Purchase Invoice.  

settlementDiscountAmount

decimal

PurchaseInvoiceLine Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Invoice Line if the Purchase Invoice is paid within a certain timeframe, expressed as an amount. From the Purchase Invoice.  

settlementDiscountPercent

decimal

PurchaseInvoiceLine Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Invoice Line if the Purchase Invoice is paid within a certain timeframe, expressed as a percentage. From the Purchase Invoice.  

settlementDiscountTerms

normalizedString

PurchaseInvoiceLine Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Purchase Invoice.  

invoiceLineDiscountType

discountType

PurchaseInvoiceLine Invoice Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Purchase Invoice Line (percent or amount)  

invoiceLineDiscountAmount

decimal

PurchaseInvoiceLine Invoice Line Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Purchase Invoice Line, expressed as an amount. From the Purchase Invoice.  

invoiceLineDiscountPercent

decimal

PurchaseInvoiceLine Invoice Line Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Purchase Invoice Line, expressed as a percentage. From the Purchase Invoice.  

invoiceLineSubtotalDiscountType

discountType

PurchaseInvoiceLine Invoice Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Purchase Invoice Lines (percent or amount) of which this Line is part.  

invoiceLineSubtotalDiscountAmount

decimal

PurchaseInvoiceLine Invoice Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Invoice Line, expressed as an amount.  

invoiceLineSubtotalDiscountPercent

decimal

PurchaseInvoiceLine Invoice Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Invoice Line, expressed as a percentage.  

actualPrice

decimal

PurchaseInvoiceLine Actual Price

 

 

 

 

 

The actual price of the Purchase Invoice Line (e.g. after discounts or adjustments). In Purchase Invoice currency.  

netTotal

decimal

PurchaseInvoiceLine Net Total

 

 

 

 

 

Total value of the Purchase Invoice Line, including discounts, excluding tax (e.g. quantity * actual price). In Purchase Invoice currency. Could be calculated.  

chargesTotal

decimal

PurchaseInvoiceLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Invoice Line (e.g. finance charges, interest, landed costs). In Purchase Invoice currency.  

fobPoint

string

PurchaseInvoiceLine FOB Point

 

X

 

 

 

The FOB point applicable to the Purchase Invoice Line. FOB is an abbreviation for Free On Board. The term FOB is used when shipping goods, to indicate who pays loading and transportation costs, and/or the point at which the responsibility of the goods transfers from shipper to buyer  

taxCodes

taxCode*

PurchaseInvoiceLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Invoice Line. See TaxCode definition.  

priceTax

decimal

PurchaseInvoiceLine Price Tax

 

X

 

 

 

Tax applicable to the Purchase Invoice Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

PurchaseInvoiceLine Tax Total

 

 

 

 

 

Tax applicable to the Purchase Invoice Line. In order currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

PurchaseInvoiceLine Gross Total

 

 

 

 

 

Total value of the Purchase Invoice Line, including discounts & tax & charges. In Purchase Invoice currency.  

dutyTotal

decimal

PurchaseInvoiceLine Duty Total

 

X

 

 

 

Total value of (import) duty applicable to the Purchase Invoice Line  

project

project

PurchaseInvoiceLine Project

 

X

 

 

reference 

Identifier of the Project this Purchase Invoice Line is for (if any). See Project definition.  

projectLine

projectLine

PurchaseInvoiceLine ProjectLine

 

X

 

 

reference 

Project Line value for this Purchase Invoice Line. See ProjectLine definition. Some applications may not have Project Lines.  

purchaseOrderDeliveryLines

purchaseOrderDeliveryLine*

PurchaseInvoiceLine PurchaseOrderDeliveryLines

 

X

 

 

association 

Link to the Delivery (receipt) Line associated with the Purchase Invoice Line. See PurchaseOrderDeliveryLine definition.  

payments

payment*

PurchaseInvoiceLine Payment

 

X

 

 

association 

A link to the (cash) payment(s) associated with this Purchase Invoice Line. See Payment definition.  

financialAccounts

financialAccount*

PurchaseInvoiceLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Invoice Line. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseInvoiceLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Invoice Line. See Cost Centre definition.  

departments

department*

PurchaseInvoiceLine Departments

 

X

 

 

association 

Department(s) associated with this Purchase Invoice Line. See Department definition.  

notes

note*

PurchaseInvoiceLine Note

 

X

 

 

child 

Notes associated with a Purchase Invoice Line (e.g. for credit control).  

Top  

Resource purchaseCredit

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseCredit Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Credit is an active one. Default = True  

reference

normalizedString

PurchaseCredit Reference

X

 

 

 

 

Reference for the Purchase Credit. 

reference2

normalizedString

PurchaseCredit Reference2

 

X

 

 

 

Additional reference for the Purchase Credit. 

status

purchaseCreditStatus

PurchaseCredit Status

 

X

 

 

 

Status of the Purchase Credit (e.g. approved, etc).  

statusFlag

boolean

PurchaseCredit Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Credit on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

PurchaseCredit Status Flag Text

 

X

 

 

 

Purchase Credit status flag text. Default = On Hold  

type

normalizedString

PurchaseCredit Type

 

X

 

 

 

Type of Purchase Credit. 

tradingAccount

tradingAccount

PurchaseCredit Supplier TradingAccount

 

 

 

 

reference 

Link to the Supplier trading account. See TradingAccount definition.  

contact

contact

PurchaseCredit Contact

 

X

 

 

reference 

Link to the Contact at Supplier who is handling the Purchase Credit. See Contact definition. Default = Primary TradingAccount Contact  

supplierReference

normalizedString

PurchaseCredit Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Credit (e.g. SO number).  

pricelist

priceList

PurchaseCredit PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Purchase Credit. See PriceList definition.  

copyFlag

boolean

PurchaseCredit Copy Flag

 

 

 

 

 

Indicates if this Purchase Credit is a copy or not. Default is false (no)  

date

date

PurchaseCredit Date

 

 

 

 

 

Date the Purchase Credit was raised. 

time

time

PurchaseCredit Time

 

X

 

 

 

Time the Purchase Credit was raised. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

taxDate

date

PurchaseCredit Tax Date

 

 

 

 

 

Used to indicate the point at which tax becomes applicable. Can default to Credit date.  

taxCodes

taxCode*

PurchaseCredit Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Credit. See TaxCode definition.  

postalAddresses

postalAddress*

PurchaseCredit PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the Purchase Credit. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

PurchaseCredit Delivery Method

 

X

 

 

 

Delivery method to be employed for the Purchase Credit (e.g. Courier, Collection, etc)  

deliveryRule

boolean

PurchaseCredit Delivery Rule

 

X

 

 

 

Flag to indicate if the order has to be delivered in full or can be split across partial deliveries. True = Partial deliveries allowed; False = Partial deliveries not allowed. Default = True  

deliveryTerms

normalizedString

PurchaseCredit Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

PurchaseCredit Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

PurchaseCredit Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Purchase Credit. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

PurchaseCredit Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Credit. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseCredit Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Credit currency.  

carrierTaxPrice

decimal

PurchaseCredit Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Credit currency. 

carrierTotalPrice

decimal

PurchaseCredit Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Credit currency.  

carrierPurchaseInvoices

purchaseInvoice*

PurchaseCredit Carrier PurchaseInvoices

 

X

 

 

association 

A link to the Purchase Invoiced charged by the carrier Company for the Delivery to the Supplier. See PurchaseCredit definition.  

carrierTaxCodes

taxCode*

PurchaseCredit Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Purchase Credit. See TaxCode definition.  

carrierReference

normalizedString

PurchaseCredit Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

PurchaseCredit Currency

 

 

 

 

 

The currency (e.g. GBP, USD, EUR) used on the Purchase Credit. ISO 4217.  

operatingCompanyCurrency

normalizedString

PurchaseCredit OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseCredit OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Credit Currency into Purchase Credit OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseCredit OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Credit Currency to Purchase Credit OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Credit Values in Purchase Credit Currency / Purchase Credit Operating Company Currency Exchange Rate = Purchase Credit Values in Purchase Credit OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseCredit OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Credit Currency to Purchase Credit OperatingCompany Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseCredit Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Purchase Credit. ISO 4217.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseCredit Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Credit currency into the Supplier Trading Account currency.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseCredit Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Credit Currency to Purchase Credit Supplier Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Credit Values in Purchase Credit Currency / Purchase Credit Supplier TradingAccount Currency Exchange Rate = Purchase Credit Values in Purchase Credit Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseCredit Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Credit Currency to Supplier Trading Account Currency, if different. Default = System date  

user

normalizedString

PurchaseCredit User

 

X

 

 

 

Link to the user who the Purchase Credit is for. The user resource will be defined in the future.  

purchaseCreditLines

purchaseCreditLine*

PurchaseCredit PurchaseCreditLine

 

 

 

 

child 

Purchase Credit Line detail. See PurchaseCreditLine definition.  

lineCount

decimal

PurchaseCredit Line Count

 

 

 

 

 

The number of lines on the Purchase Credit. Should be auto-populated. Used as a cross reference to ensure Credit integrity.  

originatorDocuments

purchaseCreditOriginatorDocument*

PurchaseCredit Originator Document References

 

X

 

 

association 

Reference to other documents (e.g. the purchase order associated with the credit). Could also include a link to the original Purchase Credit if a Credit is cancelled (reversed).  

purchaseReturnDeliveries

purchaseReturnDelivery*

PurchaseCredit PurchaseReturnDeliveries

 

X

 

 

association 

A link to the Purchase Return Delivery associated with this Credit. See PurchaseOrderDelivery definition.  

receipts

receipt*

PurchaseCredit Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Purchase Credit See Payment definition.  

contract

string

PurchaseCredit Contract

 

X

 

 

 

Reference to a contract associated with the Purchase Credit.  

settlementDiscountType

discountType

PurchaseCredit Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Purchase Credit (percent or amount). From the Trading Account.  

settlementDiscountAmount

decimal

PurchaseCredit Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Credit if the Purchase Credit is paid within a certain timeframe, expressed as an amount. From the Trading Account.  

settlementDiscountPercent

decimal

PurchaseCredit Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Credit if the Purchase Credit is paid within a certain timeframe, expressed as a percentage. From the Trading Account.  

settlementDiscountTerms

normalizedString

PurchaseCredit Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Trading Account.  

settlementDiscountIncludedInTotal

boolean

PurchaseCredit Settlement Discount Included In Total

 

X

 

 

 

Flag to indicate if settlement discount is included in Credit Totals Default = False  

invoiceDiscountType

discountType

PurchaseCredit Invoice Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Purchase Credit (percent or amount). From the Trading Account.  

invoiceDiscountAmount

decimal

PurchaseCredit Invoice Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Purchase Credit, expressed as an amount. From the Trading Account.  

invoiceDiscountPercent

decimal

PurchaseCredit Invoice Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Purchase Credit, expressed as a percentage. From the Trading Account.  

invoiceAdditionalDiscount1Type

discountType

PurchaseCredit Invoice Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Credit (percent or amount)  

invoiceAdditionalDiscount1Amount

decimal

PurchaseCredit Invoice Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Purchase Credit expressed as an amount.  

invoiceAdditionalDiscount1Percent

decimal

PurchaseCredit Invoice Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Purchase Credit expressed as a percent.  

invoiceAdditionalDiscount2Type

discountType

PurchaseCredit Invoice Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Credit (percent or amount)  

invoiceAdditionalDiscount2Amount

decimal

PurchaseCredit Invoice Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Purchase Credit expressed as an amount.  

invoiceAdditionalDiscount2Percent

decimal

PurchaseCredit Invoice Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Purchase Credit expressed as a percent.  

netTotal

decimal

PurchaseCredit Net Total

 

 

 

 

 

Total value of the Purchase Credit, including discounts, excluding tax. In Purchase Credit currency.  

discountTotal

decimal

PurchaseCredit Discount Total

 

 

 

 

 

Total discounts applied to the Purchase Credit. In Purchase Credit currency.  

chargesTotal

decimal

PurchaseCredit Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Credit (e.g. finance charges, interest, landed costs). In Purchase Credit currency.  

taxTotal

decimal

PurchaseCredit Tax Total

 

 

 

 

 

Total tax applicable to the Purchase Credit. In Purchase Credit currency.  

grossTotal

decimal

PurchaseCredit Gross Total

 

 

 

 

 

Total value of the Purchase Credit, including tax & discounts & charges. In Purchase Credit currency.  

dutyTotal

decimal

PurchaseCredit Duty Total

 

X

 

 

 

Total value of (import) duty applicable to the Purchase Credit  

text1

string

PurchaseCredit Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Credit. Header Text  

text2

string

PurchaseCredit Text2

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Credit. Footer Text  

projects

project*

PurchaseCredit Project

 

X

 

 

association 

Identifier of the Project this Purchase Credit is for. See Project definition.  

projectLines

projectLine*

PurchaseCredit ProjectLine

 

X

 

 

association 

Project Line value for this Purchase Credit. See ProjectLine definition. Some applications may not have Project Lines.  

cases

case*

PurchaseCredit Cases

 

X

 

 

association 

The reference of the case associated with the Purchase credit, e.g. if the credit is for repair/fix services. A Case entity has been defined to support the F2F process.  

financialAccounts

financialAccount*

PurchaseCredit FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Credit. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseCredit CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Credit. See Cost Centre definition.  

departments

department*

PurchaseCredit Departments

 

X

 

 

association 

Department(s) associated with this Purchase Credit. See Department definition.  

interactions

interaction*

PurchaseCredit Interactions

 

X

 

 

association 

Interaction(s) associated with the purchase order. See Interaction definition.  

notes

note*

PurchaseCredit Note

 

X

 

 

child 

Notes associated with a Purchase Credit (e.g. credit control).  

Top  

Resource purchaseCreditLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseCredit

purchaseCredit

PurchaseCreditLine Purchase Credit

 

 

 

 

parent 

The parent PurchaseCredit 

active

boolean

PurchaseCreditLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Credit Line is an active one. Default = True  

originatorDocumentLines

purchaseCreditLineOriginatorDocumentLine*

PurchaseCreditLine Originator Document Line References

 

X

 

 

association 

Reference to Lines on another document (e.g. the Purchase Invoice Line associated with the Credit Line). Purchase Credit Lines are often associated with Purchase Order Lines. Could also include a link to the original Credit Line if a Credit is cancelled (reversed).  

reference

normalizedString

PurchaseCreditLine Reference

X

 

 

 

 

Reference for the Purchase Credit. 

reference2

normalizedString

PurchaseCreditLine Reference2

 

X

 

 

 

Additional reference for the Purchase Credit. 

status

purchaseCreditStatus

PurchaseCreditLine Status

 

X

 

 

 

Status of the Purchase Credit Line. 

type

lineType

PurchaseCreditLine Type

 

X

 

X

 

Enumerator indicating the type of Purchase Credit Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

number

decimal

PurchaseCreditLine Number

 

 

 

 

 

The number of the Purchase Credit Line. For sequencing and ordering of lines.  

commodity

commodity

PurchaseCreditLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Credit Line (if any). See Commodity definition.  

text

string

PurchaseCreditLine Text

 

X

 

 

 

Text applicable to the Purchase Credit Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Credit Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseCreditLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Purchase Credit Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseCreditLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity on the Purchase Credit Line. See Dimension definition.  

deliveryDate

date

PurchaseCreditLine Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierTradingAccount

tradingAccount

PurchaseCreditLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Credit Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseCreditLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Credit currency.  

carrierTaxPrice

decimal

PurchaseCreditLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Credit currency. 

carrierTotalPrice

decimal

PurchaseCreditLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Credit currency.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

PurchaseCreditLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the Purchase Invoice Line charged by the carrier Company for the Delivery to the Supplier. See PurchaseInvoiceLine definition.  

carrierTaxCodes

taxCode*

PurchaseCreditLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Purchase Credit Line. See TaxCode definition.  

carrierReference

normalizedString

PurchaseCreditLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

unitOfMeasure

unitOfMeasure

PurchaseCreditLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

PurchaseCreditLine Quantity

 

 

 

X

 

The quantity of the Purchase Credit Line. Default to 1 if not used.  

initialPrice

decimal

PurchaseCreditLine Initial Price

 

 

 

 

 

The initial price of the Purchase Credit Line (e.g. before discounts). In Purchase Credit currency.  

pricelist

priceList

PurchaseCreditLine PriceList

 

X

 

 

reference 

A link to the Price List used to derive the Price on the Purchase Credit Line. See PriceList definition.  

settlementDiscountType

discountType

PurchaseCreditLine Settlement Discount Type

 

X

 

 

 

Flag to indicate the type of settlement discount applicable to this Purchase Credit Line (percent or amount). From the Purchase Credit.  

settlementDiscountAmount

decimal

PurchaseCreditLine Settlement Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Credit Line if the Purchase Credit is paid within a certain timeframe, expressed as an amount. From the Purchase Credit.  

settlementDiscountPercent

decimal

PurchaseCreditLine Settlement Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Credit Line if the Purchase Credit is paid within a certain timeframe, expressed as a percentage. From the Purchase Credit.  

settlementDiscountTerms

normalizedString

PurchaseCreditLine Settlement Discount Terms

 

X

 

 

 

Terms applicable to the settlement discount, often expressed as a number of days. From the Purchase Credit.  

invoiceLineDiscountType

discountType

PurchaseCreditLine Invoice Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to the Purchase Credit Line (percent or amount)  

invoiceLineDiscountAmount

decimal

PurchaseCreditLine Invoice Line Discount Amount

 

X

 

 

 

Any discount that may be applicable to the Purchase Credit Line, expressed as an amount. From the Purchase Credit.  

invoiceLineDiscountPercent

decimal

PurchaseCreditLine Invoice Line Discount Percent

 

X

 

 

 

Any discount that may be applicable to the Purchase Credit Line, expressed as a percentage. From the Purchase Credit.  

invoiceLineSubtotalDiscountType

discountType

PurchaseCreditLine Invoice Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Purchase Credit Lines (percent or amount) of which this Line is part.  

invoiceLineSubtotalDiscountAmount

decimal

PurchaseCreditLine Invoice Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Credit Line, expressed as an amount.  

invoiceLineSubtotalDiscountPercent

decimal

PurchaseCreditLine Invoice Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Credit Line, expressed as a percentage.  

actualPrice

decimal

PurchaseCreditLine Actual Price

 

 

 

 

 

The actual price of the Purchase Credit Line (e.g. after discounts or adjustments). In Purchase Credit currency.  

netTotal

decimal

PurchaseCreditLine Net Total

 

 

 

 

 

Total value of the Purchase Credit Line, including discounts, excluding tax (e.g. quantity * actual price). In Purchase Credit currency. Could be calculated.  

chargesTotal

decimal

PurchaseCreditLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Credit Line (e.g. finance charges, interest, landed costs). In Purchase Credit currency.  

fobPoint

string

PurchaseCreditLine FOB Point

 

X

 

 

 

The FOB point applicable to the Purchase Credit Line.  

taxCodes

taxCode*

PurchaseCreditLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Credit Line. See TaxCode definition.  

priceTax

decimal

PurchaseCreditLine Price Tax

 

X

 

 

 

Tax applicable to the Purchase Credit Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

PurchaseCreditLine Tax Total

 

 

 

 

 

Tax applicable to the Purchase Credit Line. In order currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

PurchaseCreditLine Gross Total

 

 

 

 

 

Total value of the Purchase Credit Line, including discounts & tax & charges. In Purchase Credit currency.  

dutyTotal

decimal

PurchaseCreditLine Duty Total

 

X

 

 

 

Total value of (import) duty applicable to the Purchase Credit Line  

project

project

PurchaseCreditLine Project

 

X

 

 

reference 

Identifier of the Project this Purchase Credit Line is for (if any). See Project definition.  

projectLine

projectLine

PurchaseCreditLine ProjectLine

 

X

 

 

reference 

Project Line value for this Purchase Credit Line. See ProjectLine definition. Some applications may not have Project Lines.  

purchaseReturnDeliveryLines

purchaseReturnDeliveryLine*

PurchaseCreditLine PurchaseOrderDeliveryLines

 

X

 

 

association 

Link to the Delivery (receipt) Line associated with the Purchase Credit Line. See PurchaseOrderDeliveryLine definition.  

receipts

receipt*

PurchaseCreditLine Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Purchase Credit Line. See receipt definition.  

receiptLines

receiptLine*

PurchaseCreditLine ReceiptLine

 

X

 

 

association 

A link to the (cash) receipt line(s) associated with this Purchase Credit Line. See receipt line definition.  

financialAccounts

financialAccount*

PurchaseCreditLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Credit Line. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseCreditLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Credit Line. See Cost Centre definition.  

departments

department*

PurchaseCreditLine Departments

 

X

 

 

association 

Department(s) associated with this Purchase Credit Line. See Department definition.  

notes

note*

PurchaseCreditLine Note

 

X

 

 

child 

Notes associated with a Purchase Credit Line (e.g. for credit control).  

Top  

Resource purchaseReturn

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseReturn Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Return is an active one. Default = True  

reference

normalizedString

PurchaseReturn Reference

X

 

 

 

 

Reference for the Purchase Return. 

reference2

normalizedString

PurchaseReturn Reference2

 

X

 

 

 

Additional reference for the Purchase Return. 

status

purchaseReturnStatus

PurchaseReturn Status

 

X

 

 

 

Status of the Purchase Return (e.g. Live, Completed).  

statusFlag

boolean

PurchaseReturn Status Flag

 

X

 

 

 

Additional Boolean status flag (e.g. Return on hold (or blocked), off hold). True is on hold, False is not on hold.  

statusFlagText

normalizedString

PurchaseReturn Status Flag Text

 

X

 

 

 

Purchase Return status flag text. Default = On Hold  

tradingAccount

tradingAccount

PurchaseReturn Supplier TradingAccount

 

 

 

 

reference 

Link to the Purchase Return Supplier account. See TradingAccount definition.  

sellerContact

contact

PurchaseReturn Seller Contact

 

X

 

 

reference 

Link to the Contact at Supplier who is handling the Purchase Return. See Contact definition. Default = Primary TradingAccount Contact  

supplierReference

normalizedString

PurchaseReturn Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Return (e.g. a return number).  

reason

string

PurchaseReturn Reason

 

X

 

 

 

The reason for the Purchase Return. 

pricelist

priceList

PurchaseReturn PriceList

 

X

 

 

reference 

Link to the Price List used when generating the Purchase Return. See PriceList definition.  

type

normalizedString

PurchaseReturn Type

 

X

 

 

 

The Purchase Return type. 

copyFlag

boolean

PurchaseReturn Copy Flag

 

 

 

 

 

Indicates if this Purchase Return is a copy or not. Default is false (no)  

originatorDocuments

purchaseReturnOriginatorDocument*

PurchaseReturn Originator Document References

 

X

 

 

association 

Reference to other Purchase Returns if required (e.g. if Return is a copy, then this will show which Return was copied, if return is for a Purchase Order, this will show which Purchase Order was returned).  

postalAddresses

postalAddress*

PurchaseReturn PostalAddress

 

X

 

 

child 

Link to Postal Address(es) associated with the purchase return. See PostalAddress definition. Could be multiple, e.g. shipping, billing, etc  

deliveryMethod

normalizedString

PurchaseReturn Delivery Method

 

X

 

 

 

Delivery method to be employed for Purchase Return (e.g. Courier, Collection, etc)  

deliveryTerms

normalizedString

PurchaseReturn Delivery Terms

 

X

 

 

 

The terms for Delivery. 

deliveryDate

date

PurchaseReturn Delivery Date

 

X

 

 

 

The anticipated date of the Delivery. 

carrierCompany

normalizedString

PurchaseReturn Carrier Company

 

X

 

 

 

Link to the Company that will be the carrier / freight forwarder/ deliverer of the Purchase Return. See Company definition. Carriers are not used by all applications.  

carrierTradingAccounts

tradingAccount*

PurchaseReturn Carrier TradingAccounts

 

X

 

 

association 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Return. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseReturn Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Return currency.  

carrierTaxPrice

decimal

PurchaseReturn Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Return currency. 

carrierTotalPrice

decimal

PurchaseReturn Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Return currency.  

carrierPurchaseInvoices

purchaseInvoice*

PurchaseReturn Carrier PurchaseInvoices

 

X

 

 

association 

A link to the purchase Invoice charged by the carrier Company for the Delivery back to the Supplier. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

PurchaseReturn Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this purchase return. See TaxCode definition.  

carrierReference

normalizedString

PurchaseReturn Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

currency

normalizedString

PurchaseReturn Currency

 

 

 

 

 

The currency of the Purchase Return (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

PurchaseReturn OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseReturn OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Return Currency into Purchase Return OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseReturn OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Return Currency to Purchase Return OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Return Values in Purchase Return Currency / Purchase Return Operating Company Currency Exchange Rate = Purchase Return Values in Purchase Return OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseReturn OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Return Currency to Purchase Return OperatingCompany Currency, if different. Default = System date  

creditCurrency

normalizedString

PurchaseReturn Credit Currency

 

X

 

 

 

The currency to be used on credit notes associated with this Return. ISO 4217. Could be derived from Return currency.  

creditCurrencyExchangeRate

decimal

PurchaseReturn Credit Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Return Currency into Purchase Return Credit Currency, if different.  

creditCurrencyExchangeRateOperator

rateOperator

PurchaseReturn Credit Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Return Currency to Purchase Return Credit Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Return Values in Purchase Return Currency / Purchase Return Invoice Currency Exchange Rate = Purchase Return Values in Purchase Return Invoice Currency.  

creditCurrencyExchangeRateDate

date

PurchaseReturn Credit Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Return Currency to Purchase Return Credit Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseReturn Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Trading Account on the Purchase Return. ISO 4217. Could be derived from order currency.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseReturn Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Return currency into the Supplier Trading Account currency, if different.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseReturn Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Return Currency to Purchase Return Supplier TradingAccount Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Return Values in Purchase Return Currency / Purchase Return Supplier TradingAccount Currency Exchange Rate = Purchase Return Values in Purchase Return Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseReturn Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Return Currency to Supplier Trading Account Currency, if different. Default = System date  

date

date

PurchaseReturn Date

 

 

 

 

 

Date the Purchase Return was placed. 

time

time

PurchaseReturn Time

 

X

 

 

 

Time the Purchase Return was placed. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used. See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

validity

decimal

PurchaseReturn Validity

 

X

 

 

 

Period the Purchase Return is valid for (days from Return Date).  

expirationDate

date

PurchaseReturn Expiration Date

 

X

 

 

 

The expiration date of the Purchase Return (PurchaseReturn Date + Validity).  

taxCodes

taxCode*

PurchaseReturn Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Return. See TaxCode definition.  

user

normalizedString

PurchaseReturn User

 

X

 

 

 

Link to the user who placed the Purchase Return. The user resource will be defined in the future.  

purchaseReturnLines

purchaseReturnLine*

PurchaseReturn PurchaseReturnLine

 

 

 

 

child 

Purchase Return Line detail (e.g. items on the Purchase Return). See PurchaseReturnLine definition.  

lineCount

decimal

PurchaseReturn Line Count

 

 

 

 

 

The number of lines on the Purchase Return. Should be auto-populated. Used as a cross reference to ensure Return integrity.  

returnDiscountType

discountType

PurchaseReturn Return Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Return (percent or amount). From the Trading Account.  

returnDiscountAmount

decimal

PurchaseReturn Return Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Return expressed as an amount. From the Trading Account.  

returnDiscountPercent

decimal

PurchaseReturn Return Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Return expressed as a percent. From the Trading Account.  

returnAdditionalDiscount1Type

discountType

PurchaseReturn Return Additional Discount1 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Return (percent or amount)  

returnAdditionalDiscount1Amount

decimal

PurchaseReturn Return Additional Discount1 Amount

 

X

 

 

 

Discount applicable to the Purchase Return expressed as an amount.  

returnAdditionalDiscount1Percent

decimal

PurchaseReturn Return Additional Discount1 Percent

 

X

 

 

 

Discount applicable to the Purchase Return expressed as a percent.  

returnAdditionalDiscount2Type

discountType

PurchaseReturn Return Additional Discount2 Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Return (percent or amount)  

returnAdditionalDiscount2Amount

decimal

PurchaseReturn Return Additional Discount2 Amount

 

X

 

 

 

Discount applicable to the Purchase Return expressed as an amount.  

returnAdditionalDiscount2Percent

decimal

PurchaseReturn Return Additional Discount2 Percent

 

X

 

 

 

Discount applicable to the Purchase Return expressed as a percent.  

text1

string

PurchaseReturn Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Return. Header text.  

text2

string

PurchaseReturn Text2

 

X

 

 

 

Further text/commentary for the Purchase Return. Footer text.  

netTotal

decimal

PurchaseReturn Net Total

 

 

 

 

 

Total value of the Purchase Return, including discounts, excluding tax. In Return currency.  

discountTotal

decimal

PurchaseReturn Discount Total

 

 

 

 

 

Total discounts applied to the Return. In Return currency  

chargesTotal

decimal

PurchaseReturn Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Return (e.g. finance charges, interest). In Return currency.  

taxTotal

decimal

PurchaseReturn Tax Total

 

 

 

 

 

Total tax applicable to the Purchase Return. In Return currency.  

grossTotal

decimal

PurchaseReturn Gross Total

 

 

 

 

 

Total value of the Purchase Return, including tax & discounts & charges. In Return currency.  

receipts

receipt*

PurchaseReturn Receipt

 

X

 

 

association 

Link to the Purchase Return receipts (e.g. if refund is entered with the Return). See Receipt definition.  

contract

string

PurchaseReturn Contract

 

X

 

 

 

Reference to a contract associated with the Purchase Return (e.g. a blanket or call-off order).  

creditTradingAccount

tradingAccount

PurchaseReturn Credit TradingAccount

 

X

 

 

reference 

Link to the Trading Account to be credited for the Purchase Return (if different from the Customer). See TradingAccount definition.  

destinationCountry

normalizedString

PurchaseReturn Destination Country

 

X

 

 

 

Country of destination for the Purchase Return (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Delivery address?  

projects

project*

PurchaseReturn Project

 

X

 

 

association 

Identifier of the Project this Purchase Return is for. See Project definition.  

projectLines

projectLine*

PurchaseReturn ProjectLine

 

X

 

 

association 

Project Line value for this Purchase Return. See ProjectLine definition. Some applications may not have Project Lines.  

cases

case*

PurchaseReturn Cases

 

X

 

 

association 

The reference of the case associated with the Purchase Return, e.g. if the Return is for repair/fix services. A Case entity has been defined to support the F2F process.  

purchaseReturnDeliveries

purchaseReturnDelivery*

PurchaseReturn PurchaseReturnDeliveries

 

X

 

 

association 

Link to the Delivery (dispatch) against the Purchase Return. If there are multiple then these are held against the Purchase Return Lines. See PurchaseReturnDeliveries definition.  

financialAccounts

financialAccount*

PurchaseReturn FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Return. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseReturn CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Return. See Cost Centre definition.  

departments

department*

PurchaseReturn Departments

 

X

 

 

association 

Department(s) associated with this Purchase Return. See Department definition.  

interactions

interaction*

PurchaseReturn Interactions

 

X

 

 

association 

Interaction(s) associated with the purchase return. See Interaction definition.  

notes

note*

PurchaseReturn Note

 

X

 

 

child 

Notes associated with a Purchase Return. 

Top  

Resource purchaseReturnLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseReturn

purchaseReturn

PurchaseReturnLine Purchase Return

 

 

 

 

parent 

The parent PurchaseReturn 

active

boolean

PurchaseReturnLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Return Line is an active one. Default = True  

reference

normalizedString

PurchaseReturnLine Reference

X

 

 

 

 

Reference for the Purchase Return Line. 

reference2

normalizedString

PurchaseReturnLine Reference2

 

X

 

 

 

Additional reference for the Purchase Return Line.  

number

decimal

PurchaseReturnLine Number

 

 

 

 

 

The number of the Purchase Return Line. For sequencing and ordering of lines.  

status

purchaseReturnStatus

PurchaseReturnLine Status

 

X

 

 

 

Status of the Purchase Return Line. 

type

lineType

PurchaseReturnLine Type

 

X

 

X

 

Enumerator indicating the type of Purchase Return Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

reason

string

PurchaseReturnLine Reason

 

X

 

 

 

Reason for the Purchase Return Line. The return reason may be different for each Line.  

deliveryTerms

normalizedString

PurchaseReturnLine Delivery Terms

 

X

 

 

 

The terms for Delivery for this Purchase Return Line. Also on Purchase Return.  

commodity

commodity

PurchaseReturnLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Return Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

PurchaseReturnLine Text

 

X

 

 

 

Text applicable to the Purchase Return Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Return Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseReturnLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the purchase return Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseReturnLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity returned on the purchase return Line. See Dimension definition.  

carrierTradingAccount

tradingAccount

PurchaseReturnLine Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Return Line. See TradingAccount definition. Carriers are not used by all application.  

carrierNetPrice

decimal

PurchaseReturnLine Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Return currency.  

carrierTaxPrice

decimal

PurchaseReturnLine Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Return currency. 

carrierTotalPrice

decimal

PurchaseReturnLine Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Return currency.  

carrierPurchaseInvoiceLine

purchaseInvoiceLine

PurchaseReturnLine Carrier PurchaseInvoiceLine

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery back to the Supplier. See PurchaseInvoice definition.  

carrierTaxCodes

taxCode*

PurchaseReturnLine Carrier Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to the carriage on this Purchase Return Line. See TaxCode definition.  

carrierReference

normalizedString

PurchaseReturnLine Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

condition

string

PurchaseReturnLine Commodity Condition

 

X

 

 

 

Condition of the Commodity being returned on the Purchase Return Line.  

deliveryLocation

location

PurchaseReturnLine Delivery Location

 

X

 

 

reference 

The Location from which the Purchase Return Line will be returned (e.g. the warehouse holding the Commodity). See Location definition.  

unitOfMeasure

unitOfMeasure

PurchaseReturnLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

PurchaseReturnLine Quantity

 

 

 

X

 

The quantity of the Commodity Returned on the Purchase Return Line.  

initialPrice

decimal

PurchaseReturnLine Initial Price

 

 

 

 

 

The initial price of the Commodity Returned on the Purchase Return Line (e.g. before discounts). In Return currency.  

pricelist

priceList

PurchaseReturnLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Purchase Return Line. See PriceList definition.  

returnLineDiscountType

discountType

PurchaseReturnLine Return Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Purchase Return Line (percent or amount). From the Purchase Return.  

returnLineDiscountAmount

decimal

PurchaseReturnLine Return Line Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Return Line, expressed as an amount. From the Purchase Return.  

returnLineDiscountPercent

decimal

PurchaseReturnLine Return Line Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Return Line, expressed as a percentage. From the Purchase Return.  

returnLineSubtotalDiscountType

discountType

PurchaseReturnLine Return Line Subtotal Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to a subtotal of Purchase Return Lines (percent or amount) of which this Line is part.  

returnLineSubtotalDiscountAmount

decimal

PurchaseReturnLine Return Line Subtotal Discount Amount

 

X

 

 

 

Discount applicable to the Purchase Return Line, expressed as an amount.  

returnLineSubtotalDiscountPercent

decimal

PurchaseReturnLine Return Line Subtotal Discount Percent

 

X

 

 

 

Discount applicable to the Purchase Return Line, expressed as a percentage.  

actualPrice

decimal

PurchaseReturnLine Actual Price

 

 

 

 

 

The actual price of the Commodity Returned on the Purchase Return Line (e.g. after discounts or adjustments). In Return currency.  

netTotal

decimal

PurchaseReturnLine Net Total

 

 

 

 

 

Total value of the Purchase Return Line, including discounts, excluding tax (e.g. quantity * actual price). In Return currency. Could be calculated.  

chargesTotal

decimal

PurchaseReturnLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Purchase Return Line (e.g. finance charges, interest). In Return currency.  

fobPoint

string

PurchaseReturnLine FOB Point

 

X

 

 

 

The FOB point applicable to the Sales Order Line. 

taxCodes

taxCode*

PurchaseReturnLine Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Purchase Return Line (default value from Purchase Return). See TaxCode definition.  

priceTax

decimal

PurchaseReturnLine Price Tax

 

X

 

 

 

Tax applicable to the Purchase Return Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

PurchaseReturnLine Tax Total

 

 

 

 

 

Tax applicable to the Purchase Return Line. In Return currency. Could be calculated. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

PurchaseReturnLine Gross Total

 

 

 

 

 

Total value of the Purchase Return Line, including discounts & tax & charges. In Return currency.  

purchaseCreditLines

purchaseCreditLine*

PurchaseReturnLine PurchaseCreditLine

 

X

 

 

association 

Purchase Credit Line(s) associated with the Purchase Return Line. See PurchaseCreditLine definition.  

receipts

receipt*

PurchaseReturnLine Receipt

 

X

 

 

association 

A link to the (cash) receipt(s) associated with this Purchase Return Line. See Receipt definition.  

receiptLines

receiptLine*

PurchaseReturnLine ReceiptLine

 

X

 

 

association 

A link to the (cash) receipt line(s) associated with this Purchase Return Line. See ReceiptLine definition.  

project

project

PurchaseReturnLine Project

 

X

 

 

reference 

Identifier of the Project this Purchase Return Line is for. See Project definition.  

projectLine

projectLine

PurchaseReturnLine ProjectLine

 

X

 

 

reference 

Project Line value for this Purchase Return Line. See ProjectLine definition. Some applications may not have Project Lines.  

purchaseReturnDeliveryLines

purchaseReturnDeliveryLine*

PurchaseReturnLine PurchaseReturnDeliveryLines

 

X

 

 

association 

Link to the Delivery (dispatch) Line against the Purchase Return Line. See PurchaseReturnDeliveries definition.  

financialAccounts

financialAccount*

PurchaseReturnLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Purchase Return Line. See FinancialAccount definition.  

costCentres

costCentre*

PurchaseReturnLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Purchase Return Line. See Cost Centre definition.  

departments

department*

PurchaseReturnLine Departments

 

X

 

 

association 

Department(s) associated with this Purchase Return Line. See Department definition.  

notes

note*

PurchaseReturnLine Note

 

X

 

 

child 

Notes associated with a Purchase Return Line. 

originatorDocumentLines

purchaseReturnLineOriginatorDocumentLine*

PurchaseReturnLine Originator Document Line References

 

X

 

 

association 

Reference to Lines on another document (e.g. the Purchase Invoice Line associated with the Return Line). Purchase Return Lines are often associated with Purchase Order Lines. Could also include a link to the original Return Line if a Return is cancelled (reversed).  

Top  

Resource purchaseOrderDelivery

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseOrderDelivery Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Order Delivery is an active one. Default = True  

purchaseOrders

purchaseOrder*

PurchaseOrderDelivery Purchase Orders

 

 

 

 

association 

Link to the Purchase Order associated with the Delivery. See Purchase Orders definition.  

reference

normalizedString

PurchaseOrderDelivery Reference

X

 

 

 

 

Reference for the Purchase Order Delivery. 

reference2

normalizedString

PurchaseOrderDelivery Reference2

 

X

 

 

 

Additional reference for the Purchase Order Delivery.  

status

purchaseOrderDeliveryStatus

PurchaseOrderDelivery Status

 

X

 

 

 

Status of the Purchase Order Delivery (e.g. Part, Complete).  

tradingAccount

tradingAccount

PurchaseOrderDelivery Supplier TradingAccount

 

 

 

 

reference 

Link to the Purchase Order Delivery Supplier account. See TradingAccount definition.  

supplierReference

normalizedString

PurchaseOrderDelivery Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Order Delivery (e.g. a Delivery booking number).  

type

normalizedString

PurchaseOrderDelivery Type

 

X

 

 

 

The Purchase Order Delivery type. 

postalAddress

postalAddress

PurchaseOrderDelivery PostalAddress

 

X

 

 

child 

Link to the actual Delivery (shipping) address for the Purchase Order Delivery. See PostalAddress definition. May be different from that originally requested on the Purchase Order.  

deliveryMethod

normalizedString

PurchaseOrderDelivery Method

 

X

 

 

 

Delivery method employed for Purchase Order Delivery (e.g. Courier, Collection, etc). May be different from that requested on the Purchase Order.  

carrierTradingAccount

tradingAccount

PurchaseOrderDelivery Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Order Delivery. See TradingAccount definition. Carriers are not used by all application.  

deliveryContact

contact

PurchaseOrderDelivery Delivery Contact

 

X

 

 

reference 

Link to the Contact at Supplier who delivered the Purchase Order Delivery. See Contact definition. Default = Primary TradingAccount Contact  

carrierReference

normalizedString

PurchaseOrderDelivery Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

carrierNetPrice

decimal

PurchaseOrderDelivery Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Delivery currency.  

carrierTaxPrice

decimal

PurchaseOrderDelivery Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Delivery currency.  

carrierTotalPrice

decimal

PurchaseOrderDelivery Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Delivery currency.  

carrierPurchaseInvoice

purchaseInvoice

PurchaseOrderDelivery Carrier PurchaseInvoice

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery from the Supplier. See PurchaseInvoice definition.  

currency

normalizedString

PurchaseOrderDelivery Currency

 

X

 

 

 

The currency of the Purchase Order Delivery (e.g. GBP, USD, EUR). ISO 4217. Must be same as the associated Purchase Order currency. Not mandatory as some applications do not hold financial information against deliveries.  

operatingCompanyCurrency

normalizedString

PurchaseOrderDelivery OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseOrderDelivery OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Order Delivery Currency into Purchase Order Delivery OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseOrderDelivery OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Order Delivery Currency to Purchase Order Delivery OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Order Delivery Values in Purchase Order Delivery Currency / Purchase Order Delivery Operating Company Currency Exchange Rate = Purchase Order Delivery Values in Purchase Order Delivery OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseOrderDelivery OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Order Delivery Currency to Purchase Order Delivery OperatingCompany Currency, if different. Default = System date  

invoiceCurrency

normalizedString

PurchaseOrderDelivery Invoice Currency

 

X

 

 

 

The currency to be used on invoices associated with this Purchase order Delivery. ISO 4217.  

invoiceCurrencyExchangeRate

decimal

PurchaseOrderDelivery Invoice Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Order Delivery Currency into Purchase Order Delivery Invoice Currency, if different.  

invoiceCurrencyExchangeRateOperator

rateOperator

PurchaseOrderDelivery Invoice Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Order Delivery Currency to Purchase Order Delivery Invoice Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Order Delivery Values in Purchase Order Delivery Currency / Purchase Order Delivery Invoice Currency Exchange Rate = Purchase Order Delivery Values in Purchase Order Delivery Invoice Currency.  

invoiceCurrencyExchangeRateDate

date

PurchaseOrderDelivery Invoice Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Order Delivery Currency to Purchase Order Delivery Invoice Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseOrderDelivery Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Supplier Trading Account on the Purchase Order Delivery. ISO 4217. Could be derived from order currency.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseOrderDelivery Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Order Delivery currency into the Supplier Trading Account currency, if different.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseOrderDelivery Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Order Delivery Currency to Purchase Order Delivery Supplier Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Order Delivery Values in Purchase Order Delivery Currency / Purchase Order Delivery Supplier Trading Account Currency Exchange Rate = Purchase Order Delivery Values in Purchase Order Delivery Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseOrderDelivery Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Order Delivery Currency to Supplier Trading Account Currency, if different. Default = System date  

requestedDeliveryDate

date

PurchaseOrderDelivery Requested Delivery Date

 

X

 

 

 

The requested date of the Delivery, from the Purchase Order.  

actualDeliveryDate

date

PurchaseOrderDelivery Actual Delivery Date

 

 

 

 

 

The actual date of the Purchase Order Delivery. 

actualDeliveryTime

time

PurchaseOrderDelivery Actual Delivery Time

 

X

 

 

 

The actual time of the Purchase Order Delivery. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dateExceptionReason

string

PurchaseOrderDelivery Date Exception Reason

 

X

 

 

 

A reason for the difference in Delivery dates for the Purchase Order, if any.  

purchaseOrderDeliveryLines

purchaseOrderDeliveryLine*

PurchaseOrderDelivery PurchaseOrderDeliveryLine

 

 

 

 

child 

Purchase Order Delivery Line detail (e.g. items on the Purchase Order Delivery). See PurchaseOrderDeliveryLine definition.  

lineCount

decimal

PurchaseOrderDelivery Line Count

 

 

 

 

 

The number of lines on the Purchase Order Delivery. Should be auto-populated. Used as a cross reference to ensure order integrity.  

requestedQuantity

decimal

PurchaseOrderDelivery Requested Quantity

 

X

 

 

 

The total quantity of the Commodity requested on the Purchase Order Delivery (from the associated Purchase Order).  

deliveredQuantity

decimal

PurchaseOrderDelivery Delivered Quantity

 

 

 

 

 

The total quantity of the Commodity delivered on the Purchase Order Delivery.  

text1

string

PurchaseOrderDelivery Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Order Delivery. Header text.  

text2

string

PurchaseOrderDelivery Text2

 

X

 

 

 

Further text/commentary for the Purchase Order Delivery. Footer text.  

destinationCountry

normalizedString

PurchaseOrderDelivery Destination Country

 

X

 

 

 

Country of destination for the Purchase Order Delivery (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Delivery address?  

user

normalizedString

PurchaseOrderDelivery User

 

X

 

 

 

The user responsible for the Purchase Order Delivery, e.g. the person receiving the Purchase Order. The user resource will be defined in the future.  

cases

case*

PurchaseOrderDelivery Cases

 

X

 

 

association 

The reference of the case associated with the Purchase Order Delivery, e.g. if the Case is for problems incurred during delivery. A Case entity has been defined to support the F2F process.  

interactions

interaction*

PurchaseOrderDelivery Interactions

 

X

 

 

association 

Interaction(s) associated with the purchase order Delivery. See Interaction definition.  

notes

note*

PurchaseOrderDelivery Notes

 

X

 

 

child 

Notes associated with a Purchase Order Delivery. 

Top  

Resource purchaseOrderDeliveryLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseOrderDelivery

purchaseOrderDelivery

PurchaseOrderDeliveryLine Delivery

 

 

 

X

parent 

The Purchase Order Delivery this Line belongs to. See PurchaseOrderDelivery definition.  

active

boolean

PurchaseOrderDeliveryLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Order Delivery Line is an active one. Default = True  

reference

normalizedString

PurchaseOrderDeliveryLine Reference

X

 

 

 

 

Reference for the Purchase Order Delivery Line. 

reference2

normalizedString

PurchaseOrderDeliveryLine Reference2

 

X

 

 

 

Additional reference for the Purchase Order Delivery Line.  

number

decimal

PurchaseOrderDeliveryLine Number

 

 

 

 

 

The number of the Purchase Order Delivery Line. For sequencing and ordering of lines.  

status

purchaseOrderDeliveryStatus

PurchaseOrderDeliveryLine Status

 

X

 

 

 

Status of the Purchase Order Delivery Line (e.g. Part, Complete).  

commodity

commodity

PurchaseOrderDeliveryLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Order Delivery Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

PurchaseOrderDeliveryLine Text

 

X

 

 

 

Text applicable to the Purchase Order Delivery Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Order Delivery Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseOrderDeliveryLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the purchase order Delivery Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseOrderDeliveryLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity delivered on the purchase order Delivery Line. See Dimension definition.  

fulfillmentLocation

location

PurchaseOrderDeliveryLine Fulfillment Location

 

X

 

 

reference 

The Location from which the Purchase Order Delivery Line was fulfilled. See Location definition.  

fulfillmentSubLocation

location

PurchaseOrderDeliveryLine Fulfilment Sub-Location

 

X

 

 

reference 

The sub-Location from which the Purchase Order Delivery Line was fulfilled. See Location definition.  

unitOfMeasure

unitOfMeasure

PurchaseOrderDeliveryLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

requestedQuantity

decimal

PurchaseOrderDeliveryLine Requested Quantity

 

 

 

 

 

The quantity of the Commodity requested on the Purchase Order Delivery Line.  

deliveredQuantity

decimal

PurchaseOrderDeliveryLine Delivered Quantity

 

 

 

 

 

The quantity of the Commodity delivered on the Purchase Order Delivery Line.  

notes

note*

PurchaseOrderDeliveryLine Note

 

X

 

 

child 

Notes associated with a Purchase Order Delivery Line.  

Top  

Resource purchaseReturnDelivery

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PurchaseReturnDelivery Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Return Delivery is an active one. Default = True  

tradingAccount

tradingAccount

PurchaseReturnDelivery Supplier TradingAccount

 

 

 

 

reference 

Link to the Purchase Return Delivery Supplier account. See TradingAccount definition.  

purchaseReturn

purchaseReturn

PurchaseReturnDelivery Purchase Return

 

 

 

 

reference 

Link to the Purchase Return associated with the Delivery. See Purchase Orders definition.  

reference

normalizedString

PurchaseReturnDelivery Reference

X

 

 

 

 

Reference for the Purchase Return Delivery. 

reference2

normalizedString

PurchaseReturnDelivery Reference2

 

X

 

 

 

Additional reference for the Purchase Return Delivery.  

status

purchaseReturnDeliveryStatus

PurchaseReturnDelivery Status

 

X

 

 

 

Status of the Purchase Return Delivery (e.g. Part, Complete).  

returnContact

contact

PurchaseReturnDelivery Return Contact

 

X

 

 

reference 

Link to the Contact at Supplier who received the Purchase Order Return Delivery. See Contact definition. Default = Primary TradingAccount Contact  

supplierReference

normalizedString

PurchaseReturnDelivery Supplier Reference

 

X

 

 

 

Supplier own reference for the Purchase Return Delivery (e.g. a Delivery booking number).  

type

normalizedString

PurchaseReturnDelivery Type

 

X

 

 

 

The Purchase Return Delivery type. 

postalAddress

postalAddress

PurchaseReturnDelivery PostalAddress

 

X

 

 

child 

Link to the actual Delivery (shipping) address for the Purchase Return Delivery. See PostalAddress definition. May be different from that originally requested on the Purchase Order.  

deliveryMethod

normalizedString

PurchaseReturnDelivery Method

 

X

 

 

 

Delivery method employed for Purchase Return Delivery (e.g. Courier, Collection, etc). May be different from that requested on the Purchase Order.  

carrierTradingAccount

tradingAccount

PurchaseReturnDelivery Carrier TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the carrier / freight forwarder / deliverer of the Purchase Return Delivery. See TradingAccount definition. Carriers are not used by all application.  

carrierReference

normalizedString

PurchaseReturnDelivery Carrier Reference

 

X

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

carrierNetPrice

decimal

PurchaseReturnDelivery Carrier Net Price

 

X

 

 

 

The price of Delivery/carriage. In Delivery currency.  

carrierTaxPrice

decimal

PurchaseReturnDelivery Carrier Tax Price

 

X

 

 

 

The tax on Delivery/carriage. In Delivery currency.  

carrierTotalPrice

decimal

PurchaseReturnDelivery Carrier Gross Price

 

X

 

 

 

The total price of Delivery/carriage (net + VAT). In Delivery currency.  

carrierPurchaseInvoice

purchaseInvoice

PurchaseReturnDelivery Carrier PurchaseInvoice

 

X

 

 

reference 

A link to the purchase Invoice charged by the carrier Company for the Delivery to the Supplier. See PurchaseInvoice definition.  

currency

normalizedString

PurchaseReturnDelivery Currency

 

X

 

 

 

The currency of the Purchase Return Delivery (e.g. GBP, USD, EUR). ISO 4217. Must be same as the associated Purchase Order currency. Not mandatory as some applications do not hold financial information against deliveries.  

operatingCompanyCurrency

normalizedString

PurchaseReturnDelivery OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

PurchaseReturnDelivery OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Return Delivery Currency into Purchase Return Delivery OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

PurchaseReturnDelivery OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Return Delivery Currency to Purchase Return Delivery OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Return Delivery Values in Purchase Return Delivery Currency / Purchase Return Delivery Operating Company Currency Exchange Rate = Purchase Return Delivery Values in Purchase Return Delivery OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

PurchaseReturnDelivery OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Return Delivery Currency to Purchase Return Delivery OperatingCompany Currency, if different. Default = System date  

invoiceCurrency

normalizedString

PurchaseReturnDelivery Invoice Currency

 

X

 

 

 

The currency to be used on invoices associated with this Purchase Return Delivery. ISO 4217.  

invoiceCurrencyExchangeRate

decimal

PurchaseReturnDelivery Invoice Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Purchase Return Delivery Currency into Purchase Return Delivery Invoice Currency, if different.  

invoiceCurrencyExchangeRateOperator

rateOperator

PurchaseReturnDelivery Invoice Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Return Delivery Currency to Purchase Return Delivery Invoice Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Return Delivery Values in Purchase Return Delivery Currency / Purchase Return Delivery Invoice Currency Exchange Rate = Purchase Return Delivery Values in Purchase Return Delivery Invoice Currency.  

invoiceCurrencyExchangeRateDate

date

PurchaseReturnDelivery Invoice Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Return Delivery Currency to Purchase Return Delivery Invoice Currency, if different. Default = System date  

supplierTradingAccountCurrency

normalizedString

PurchaseReturnDelivery Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Supplier Trading Account on the Purchase Return Delivery. ISO 4217. Could be derived from order currency.  

supplierTradingAccountCurrencyExchangeRate

decimal

PurchaseReturnDelivery Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Purchase Return Delivery currency into the Supplier Trading Account currency, if different.  

supplierTradingAccountCurrencyExchangeRateOperator

rateOperator

PurchaseReturnDelivery Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Purchase Return Delivery Currency to Purchase Return Delivery Supplier Trading Account Currency. * (multiplication) or / division. E.g. if the operator is division then it is Purchase Return Delivery Values in Purchase Return Delivery Currency / Purchase Return Delivery Supplier Trading Account Currency Exchange Rate = Purchase Return Delivery Values in Purchase Return Delivery Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

PurchaseReturnDelivery Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Purchase Return Delivery Currency to Supplier Trading Account Currency, if different. Default = System date  

requestedDeliveryDate

date

PurchaseReturnDelivery Requested Delivery Date

 

X

 

 

 

The requested date of the Delivery, from the Purchase Order.  

actualDeliveryDate

date

PurchaseReturnDelivery Actual Delivery Date

 

 

 

 

 

The actual date of the Purchase Return Delivery. 

actualDeliveryTime

time

PurchaseReturnDelivery Actual Delivery Time

 

X

 

 

 

The actual time of the Purchase Return Delivery. W3C date time standard for XML (ISO 8601). The base timezone is UTC. The offset is included. UTC should be used See the reference here: http://www.w3.org/TR/xmlschema-2/#isoformats  

dateExceptionReason

string

PurchaseReturnDelivery Date Exception Reason

 

X

 

 

 

A reason for the difference in Delivery dates for the Purchase Order, if any.  

purchaseReturnDeliveryLines

purchaseReturnDeliveryLine*

PurchaseReturnDelivery PurchaseReturnDeliveryLine

 

 

 

 

child 

Purchase Return Delivery Line detail (e.g. items on the Purchase Return Delivery). See PurchaseOrderDeliveryLine definition.  

lineCount

decimal

PurchaseReturnDelivery Line Count

 

 

 

 

 

The number of lines on the Purchase Return Delivery. Should be auto-populated. Used as a cross reference to ensure order integrity.  

requestedQuantity

decimal

PurchaseReturnDelivery Requested Quantity

 

X

 

 

 

The total quantity of the Commodity requested on the Purchase Return Delivery (from the associated Purchase Order).  

deliveredQuantity

decimal

PurchaseReturnDelivery Delivered Quantity

 

 

 

 

 

The total quantity of the Commodity delivered on the Purchase Return Delivery.  

text1

string

PurchaseReturnDelivery Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Purchase Return Delivery. Header text.  

text2

string

PurchaseReturnDelivery Text2

 

X

 

 

 

Further text/commentary for the Purchase Return Delivery. Footer text.  

destinationCountry

normalizedString

PurchaseReturnDelivery Destination Country

 

X

 

 

 

Country of destination for the Purchase Return Delivery (e.g. for customs purposes). ISO 3166-1 alpha-2 country codes only Could be derived from Delivery address?  

user

normalizedString

PurchaseReturnDelivery User

 

X

 

 

 

The user responsible for the Purchase Return Delivery, e.g. the person receiving the Purchase Order. The user resource will be defined in the future.  

interactions

interaction*

PurchaseReturnDelivery Interactions

 

X

 

 

association 

Interaction(s) associated with the Purchase Return Delivery. See Interaction definition.  

notes

note*

PurchaseReturnDelivery Note

 

X

 

 

child 

Notes associated with a Purchase Return Delivery. 

Top  

Resource purchaseReturnDeliveryLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

purchaseReturnDelivery

purchaseReturnDelivery

PurchaseReturnDeliveryLine Delivery

 

 

 

X

parent 

The Purchase Return Delivery this Line belongs to. See PurchaseReturnDelivery definition.  

active

boolean

PurchaseReturnDeliveryLine Active Flag

 

 

 

 

 

Flag to indicate if the Purchase Return Delivery Line is an active one. Default = True  

reference

normalizedString

PurchaseReturnDeliveryLine Reference

X

 

 

 

 

Reference for the Purchase Return Delivery Line. 

reference2

normalizedString

PurchaseReturnDeliveryLine Reference2

 

X

 

 

 

Additional reference for the Purchase Return Delivery Line.  

number

decimal

PurchaseReturnDeliveryLine Number

 

 

 

 

 

The number of the Purchase Return Delivery Line. For sequencing and ordering of lines.  

status

purchaseReturnDeliveryStatus

PurchaseReturnDeliveryLine Status

 

X

 

 

 

Status of the Purchase Return Delivery Line (e.g. Part, Complete).  

commodity

commodity

PurchaseReturnDeliveryLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Purchase Return Delivery Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

PurchaseReturnDeliveryLine Text

 

X

 

 

 

Text applicable to the Purchase Return Delivery Line (e.g. the Line may be a comment Line or a free text Line). If the Purchase Return Delivery Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

PurchaseReturnDeliveryLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Purchase Return Delivery Line. See Variant definition.  

commodityDimension

commodityDimension

PurchaseReturnDeliveryLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity delivered on the Purchase Return Delivery Line. See Dimension definition.  

fulfillmentLocation

location

PurchaseReturnDeliveryLine Fulfillment Location

 

X

 

 

reference 

The Location from which the Purchase Return Delivery Line was fulfilled. See Location definition.  

fulfillmentSubLocation

location

PurchaseReturnDeliveryLine Fulfilment Sub-Location

 

X

 

 

reference 

The sub-Location from which the Purchase Return Delivery Line was fulfilled. See Location definition.  

unitOfMeasure

unitOfMeasure

PurchaseReturnDeliveryLine UnitOfMeasure

 

 

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

requestedQuantity

decimal

PurchaseReturnDeliveryLine Requested Quantity

 

 

 

 

 

The quantity of the Commodity requested on the Purchase Return Delivery Line.  

deliveredQuantity

decimal

PurchaseReturnDeliveryLine Delivered Quantity

 

 

 

 

 

The quantity of the Commodity delivered on the Purchase Return Delivery Line.  

notes

note*

PurchaseReturnDeliveryLine Notes

 

X

 

 

child 

Notes associated with a Purchase Return Delivery Line.  

Top  

Resource receipt

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Receipt Active Flag

 

 

 

 

 

Flag to indicate if the Receipt is an active one. Default = True  

type

normalizedString

Receipt Type

 

X

 

 

 

Type of the Receipt (e.g. pre-payment, payment on account, etc).  

bankAccount

bankAccount

Receipt BankAccount

 

X

 

 

reference 

Bank Account to which the Receipt was received. See BankAccount definition.  

source

normalizedString

Receipt Source

 

X

 

 

 

Source of the Receipt (e.g. BACS/ACH, check, cash, direct debit).  

status

normalizedString

Receipt Status

 

X

 

 

 

Status of the Receipt (e.g. cleared, pending, authorized etc).  

tenderType

normalizedString

Receipt Tender Type

 

X

 

 

 

The tendering method used for the Receipt (e.g. cash, check, credit card (VISA, Amex, etc), bank transfer, etc).  

tenderReference

normalizedString

Receipt Tender Reference

 

X

 

 

 

Reference for the Receipt associated with the tender type (e.g. check number, credit card number, etc).  

externalReference

normalizedString

Receipt Tender External Reference

 

X

 

 

 

Reference for the Receipt associated with the processor of the tender type (e.g. credit card authorization reference). Sage payment solutions reference?  

reference

normalizedString

Receipt Reference

X

 

 

 

 

Reference for the Receipt. 

reference2

normalizedString

Receipt Reference2

 

X

 

 

 

Additional reference for the Receipt. 

date

date

Receipt Date

 

X

 

 

 

The date of the Receipt. 

processDate

date

Receipt Process Date

 

X

 

 

 

The date the Receipt was processed, e.g. by the Bank Account (if different).  

tradingAccount

tradingAccount

Receipt TradingAccount

 

X

 

 

reference 

Trading Account (e.g. Customer/Supplier) from which the Receipt was received. See TradingAccount definition. Not mandatory as Receipt can also be against a Financial Account.  

tradingAccountReference

normalizedString

Receipt TradingAccount Reference

 

X

 

 

 

Trading Account's own reference for the Receipt. 

pricelist

priceList

Receipt PriceList

 

X

 

 

reference 

Link to the Price List used when generating (additional/cash sales) on the receipt. See PriceList definition.  

originatorDocuments

receiptOriginatorDocument*

Receipt Originator Document References

 

X

 

 

association 

Reference to other documents if the Receipt is for that document (e.g. a Sales Invoice). If there are multiple (i.e. a Receipt is for many Sales Invoices) then this will be set on the Receipt Line.  

taxCodes

taxCode*

Receipt Tax Codes

 

X

 

 

association 

Tax code governing the tax regime applicable to this Receipt. See TaxCode definition.  

salesPersons

salesPerson*

Receipt SalesPersons

 

X

 

 

association 

Sales person associated with the Receipt. See SalesPerson definition. Also known as Sales Agent or Manager in some applications. There may be multiple and commission may be spread across multiple sales people.  

currency

normalizedString

Receipt Currency

 

 

 

 

 

The currency of the Receipt (e.g. GBP, USD, EUR). ISO 4217. Default = Bank Account Currency  

operatingCompanyCurrency

normalizedString

Receipt OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Receipt OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Receipt Currency into Receipt OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Receipt OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Receipt Currency to Receipt OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Receipt Values in Receipt Currency / Receipt Operating Company Currency Exchange Rate = Receipt Values in Receipt OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Receipt OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Receipt Currency to Receipt OperatingCompany Currency, if different. Default = System date  

bankAccountCurrency

normalizedString

Receipt Bank Account Currency

 

 

 

 

 

The currency used by the receiving bank account. ISO 4217.  

bankAccountCurrencyExchangeRate

decimal

Receipt Bank Account Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Receipt Currency into Bank Account currency, if different.  

bankAccountCurrencyExchangeRateOperator

rateOperator

Receipt Bank Account Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Receipt Bank Account Currency to Receipt Currency. * (multiplication) or / division. E.g. if the operator is division then it is Receipt Values in Receipt Currency / Receipt Bank Account Currency Exchange Rate = Receipt Values in Receipt Bank Account Currency.  

bankAccountCurrencyExchangeRateDate

date

Receipt Bank Account Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Receipt Currency to Bank Account Currency, if different. Default = System date  

netTotal

decimal

Receipt Net Total

 

X

 

 

 

The net amount of the Receipt. In Receipt Currency.  

balanceBefore

decimal

Receipt BankAccount Balance Before

 

X

 

 

 

The balance of the Bank Account receiving the Receipt before the actual amount is applied. In Receipt Currency.  

balanceAfter

decimal

Receipt BankAccount Balance After

 

X

 

 

 

The balance of the Bank Account receiving the Receipt after the actual amount is applied. In Receipt Currency.  

discountTotal

decimal

Receipt Discount Total

 

X

 

 

 

The value of any discount that has been taken off the receipt. In Receipt Currency.  

chargesTotal

decimal

Receipt Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Receipt (e.g. finance charges, interest). In Receipt currency.  

taxTotal

decimal

Receipt Tax Total

 

X

 

 

 

The value of any tax that has been included in the receipt. In Receipt Currency.  

grossTotal

decimal

Receipt Gross Total

 

X

 

 

 

The value of the receipt if tax and discounts are included (e.g. the actual amount received). In Receipt Currency.  

name

normalizedString

Receipt Name

 

X

 

 

 

Name of the Receipt. 

description

normalizedString

Receipt Description

 

X

 

 

 

A description or narrative associated with the Receipt.  

text1

string

Receipt Text1

 

X

 

 

 

Text/commentary (e.g. special picking/packing instructions) for the Receipt. Header text  

text2

string

Receipt Text2

 

X

 

 

 

Text/commentary (e.g. special picking/packing instructions) for the Receipt. Footer text  

receiptLines

receiptLine*

Receipt ReceiptLine

 

X

 

 

child 

Receipt Line detail. Lines are used when Receipt are allocated across multiple invoices, financial accounts or Project. See ReceiptLine definition. Not mandatory as some applications do not have Receipt Lines.  

lineCount

decimal

Receipt Line Count

 

X

 

 

 

The number of lines on the Receipt. Should be auto-populated. Used as a cross reference to ensure integrity.  

user

normalizedString

Receipt User

 

X

 

 

 

The user responsible for the Receipt. The user resource will be defined in the future.  

financialAccounts

financialAccount*

Receipt FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Receipt. See FinancialAccount definition.  

costCentres

costCentre*

Receipt CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Receipt. See Cost Centre definition.  

departments

department*

Receipt Departments

 

X

 

 

association 

Department(s) associated with this Receipt. See Department definition.  

projects

project*

Receipt Project

 

X

 

 

association 

Identifier of the Project this Receipt is for. See Project definition. Receipt Line values may be used instead.  

projectLines

projectLine*

Receipt ProjectLine

 

X

 

 

association 

Project Line value for this receipt. See ProjectLine definition. Receipt Line values may be used instead. Some applications may not have Project Lines.  

interactions

interaction*

Receipt Interactions

 

X

 

 

association 

Interaction(s) associated with the receipt. See Interaction definition.  

notes

note*

Receipt Note

 

X

 

 

child 

Notes associated with the Receipt. 

tenderTransactionType

tenderTransactionType

Receipt Tender Transaction Type

 

X

 

 

 

The type of transaction associated with the receipt tender (e.g. credit card) e.g. credit card receipt, credit card authenticate (only),  

tenderStartDate

string

Receipt Tender Start Date

 

X

 

 

 

The Start date (required for some Maestro, Solo and Amex card) in MMYY format. 

tenderExpiryDate

string

Receipt Tender Expiry Date

 

X

 

 

 

The Expiry date (required for ALL cards) in MMYY format. 

tenderCV2Number

string

Receipt Tender CV2 Number

 

X

 

 

 

The extra security 3 digits on the signature strip of the card, or the extra 4 digits on the front for American Express Cards 

tenderIssueNumber

decimal

Receipt Tender Issue Number

 

X

 

 

 

The card Issue Number (some Maestro and Solo cards only) 

tenderPayPalCallBackURL

string

Receipt Pay Pal Call Back URL

 

X

 

 

 

Full qualified domain name of the URL to which customers are redirected upon completion of a PayPal transaction 

tenderGiftAidFlag

boolean

Receipt Gift Aid Flag

 

 

 

 

 

FALSE = This transaction is not a Gift Aid charitable donation (default) TRUE = This payment is a Gift Aid charitable donation and the customer has AGREED to donate the tax. 

tenderApplyAVSCV2

tenderApplyEnum

Receipt Tender Apply AVS CV2

 

X

 

 

 

AVS = address verification service, CV2 = extra 3 security digits on cards. 0 = If AVS/CV2 enabled then check them. If rules apply, use rules (default). 1 = Force AVS/CV2 checks even if not enabled for the account. If rules apply, use rules. 2 = Force NO AVS/CV2 checks even if enabled on account. 3 = Force AVS/CV2 checks even if not enabled for the account but DON’T apply any rules. 

tenderClientIPAddress

string

Receipt Tender Client IP Address

 

X

 

 

 

The IP address of the client connecting to the server making the payment. 

tenderApply3DSecure

tenderApplyEnum

Receipt Tender Apply 3D Secure

 

X

 

 

 

0 = If 3D-Secure checks are possible and rules allow, perform the checks and apply the authorisation rules (default). 1 = Force 3D-Secure checks for this transaction only (if your account is 3D-enabled) and apply rules for authorisation. 2 = Do not perform 3D-Secure checks for this transaction only and always authorise. 3 = Force 3D-Secure checks for this transaction (if your account is 3D-enabled) but ALWAYS obtain an auth code, irrespective of rule base. 

tenderAccountType

tenderAccountType

Receipt Tender Account Type

 

X

 

 

 

E = Use the e-commerce merchant account (default). C = Use the continuous authority merchant account (if present). M = Use the mail order, telephone order account (if present). 

tenderPayPalBillingAgreement

boolean

Receipt Tender PayPal Billing Agreement

 

 

 

 

 

FALSE = This is a normal PayPal transaction, not the first in a series of payments (default) TRUE = This is the first in a series of PayPal payments. Subsequent payments can be taken using REPEAT. 

statusText

string

Receipt Status Text

 

X

 

 

 

Human readable text associated with the status 

tenderSecurityKey

string

Receipt Tender Security Key

 

X

 

 

 

Security key to be used to generate an MD5 Hash to sign the transaction.  

tenderTransactionAuthNo

decimal

Receipt Tender Transaction Auth No

 

X

 

 

 

The Sage Pay authorisation code (also called VPSAuthCode) for this transaction. Sage Pay name is TXAuthNo. 

tenderAVSCV2Response

tenderAVSCV2Response

Receipt Tender AVSCV2 Response

 

X

 

 

 

Response from AVS and CV2 checks. Will be one of the following: ALL MATCH, SECURITY CODE MATCH ONLY, ADDRESS MATCH ONLY, NO DATA MATCHES or DATA NOT CHECKED.  

tenderAddressResult

tenderResult

Receipt Tender Address Result

 

X

 

 

 

NOTPROVIDED, NOTCHECKED, MATCHED, NOTMATCHED 

tenderPostCodeResult

tenderResult

Receipt Tender PostCode Result

 

X

 

 

 

NOTPROVIDED, NOTCHECKED, MATCHED, NOTMATCHED 

tenderCV2Result

tenderResult

Receipt Tender CV2 Result

 

X

 

 

 

NOTPROVIDED, NOTCHECKED, MATCHED, NOTMATCHED 

tender3DSecureStatus

tender3DSecureStatus

Receipt Tender 3D Secure Status

 

X

 

 

 

OK – The 3D-Authentication step completed successfully. If the Status field is OK too, then this indicates that the authorized transaction was also 3D-authenticated and a CAVV will be returned. Liability shift occurs. NOAUTH – This means the card is not in the 3D-Secure scheme. CANTAUTH - This normally means the card Issuer is not part of the scheme. NOTAUTHED – The cardholder failed to authenticate themselves with their Issuing Bank. ATTEMPTONLY – The cardholder attempted to authenticate themselves but the process did not complete. A CAVV is returned, therefore a liability shift may occur for non-Maestro cards. Check your Merchant Agreement. NOTCHECKED - No 3D Authentication was attempted for this transaction. Always returned if 3D-Secure is not active on your account. INCOMPLETE – 3D-Secure authentication was unable to complete (normally at the card issuer site). No authentication occurred. MALFORMED,INVALID,ERROR – These statuses indicate a problem with creating or receiving the 3D-Secure data. These should not occur on the live environment. 

tenderCAVV

string

Receipt Tender CAVV

 

X

 

 

 

The encoded result code from the 3D-Secure checks. Holds the Visa CAVV or the MasterCard UCAF depending on the card type used in the transaction. CAVV = Cardholder Authentication Verification Value 

tenderMD

string

Receipt Tender MD

 

X

 

 

 

A unique reference for the 3D-Authentication attempt. 

tenderACSURL

string

Receipt Tender ACS URL

 

X

 

 

 

A fully qualified URL that points to the 3D-Authentication system at the Cardholder’s Issuing Bank. 

tenderPaRequest

string

Receipt Tender Pa Request

 

X

 

 

 

A Base64 encoded, encrypted message to be passed to the Issuing Bank as part of the 3D-Authentication. 

tenderPaResult

string

Receipt Tender Pa Result

 

X

 

 

 

A Base64 encoded, encrypted message sent back by Issuing Bank to your Terminal URL at the end of the 3D-Authentication process. 

tenderPayPalRedirectURL

string

Receipt Tender PayPal Redirect URL

 

X

 

 

 

A fully qualified domain name URL to which you should redirect the customer. Contain the PayPal token which should not be stripped out. 

tenderAddressStatus

tenderAddressStatus

Receipt Tender Address Status

 

X

 

 

 

Either NONE, CONFIRMED or UNCONFIRMED 

tenderPayerStatus

tenderPayerStatus

Receipt Tender Payer Status

 

X

 

 

 

Either VERIFIED or UNVERIFIED 

tenderPayerID

string

Receipt Tender Payer ID

 

X

 

 

 

Unique Pay Pal User Reference ID 

tenderAccept

boolean

Receipt Tender Accept

 

 

 

 

 

TRUE if you wish to proceed with the PayPal transaction, FALSE if you wish to cancel based on the information returned. 

tenderNotificationURL

string

Receipt Tender Notification URL

 

X

 

 

 

Callback URL to which Notification POSTs are sent.  

tenderProfile

tenderProfile

Receipt Tender Profile

 

X

 

 

 

NORMAL (Default) LOW 

tenderNextURL

string

Receipt Tender Next URL

 

X

 

 

 

URL to which the Vendor must redirect the Customer to continue the Transaction. 

tenderLast4Digits

decimal

Receipt Tender Last 4 Digits

 

X

 

 

 

The last 4 digits of the card number used in this transaction. PayPal transactions have 0000. 

tenderSignature

string

Receipt Tender Signature

 

X

 

 

 

Electronic signature of the receipt. 

tenderRedirectURL

string

Receipt Tender Redirect URL

 

X

 

 

 

Full qualified URL (including http:// or https:// header) to which you’d like the customer redirected on completion of the transaction. 

accepted

boolean

Receipt Accepted Flag

 

 

 

 

 

Flag to indicate if the Receipt Tender is ‘Accepted’ ie. complete.  

tenderFirst6Digits

decimal

Receipt Tender First 6 Digits

 

X

 

 

 

The first 6 digits of the card number used in this transaction. PayPal transactions have 000000. 

operatingCompany

operatingCompany

Receipt OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the receipt (customer payment).  

Top  

Resource receiptLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

receipt

receipt

ReceiptLine Receipt

 

 

 

 

parent 

The Receipt this Receipt Line is for. See Receipt definition.  

active

boolean

ReceiptLine Active Flag

 

 

 

 

 

Flag to indicate if the Receipt Line is an active one. Default = True  

reference

normalizedString

ReceiptLine Reference

X

 

 

 

 

Reference for the Receipt Line (e.g. check or BACS number).  

reference2

normalizedString

ReceiptLine Reference2

 

X

 

 

 

Additional reference for the Receipt Line (e.g. check or BACS number).  

number

decimal

ReceiptLine Number

 

 

 

 

 

The number of the Receipt Line. For sequencing and ordering of lines.  

date

date

ReceiptLine Date

 

X

 

 

 

The date of the Receipt Line. May be different to the Receipt date if the Receipt is allocated at a later date.  

originatorDocuments

receiptLineOriginatorDocument*

ReceiptLine Originator Document References

 

X

 

 

association 

Reference to other documents if the Receipt Line is for that document (e.g. a Sales Invoice). A single Receipt can be for many documents/invoices. See Sales Invoice definition.  

originatorDocumentLines

receiptLineOriginatorDocumentLine*

ReceiptLine Originator Document Line References

 

X

 

 

association 

Reference to other document Lines if the Receipt Line is for that document (e.g. a Sales Invoice Line). A single Receipt can be for many document lines/Invoice lines. See SalesInvoiceLine definition.  

status

normalizedString

ReceiptLine Status

 

X

 

 

 

Status of the Receipt Line 

type

lineType

ReceiptLine Type

 

X

 

X

 

Enumerator indicating the type of Receipt Line. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

commodity

commodity

ReceiptLine Commodity

 

X

 

 

reference 

Link to the Commodity used on the Receipt Line. See Commodity definition. Not mandatory as Line may be a free text or comment Line.  

text

string

ReceiptLine Text

 

X

 

 

 

Text applicable to the Receipt Line (e.g. the Line may be a comment Line or a free text Line). If the Receipt Line is for a Commodity then the Commodity description should be held here.  

commodityVariant

commodityVariant

ReceiptLine Commodity Variant

 

X

 

 

reference 

The Variant of the Commodity (e.g. colour or size) on the Receipt Line. See Variant definition.  

commodityDimension

commodityDimension

ReceiptLine Commodity Dimension

 

X

 

 

reference 

The Dimension of the Commodity delivered on the Receipt Line. See Dimension definition.  

unitOfMeasure

unitOfMeasure

ReceiptLine UnitOfMeasure

 

X

 

 

reference 

A link to the scale to be used in the measurement of physical quantities of Commodity on the receipt Line. Examples include Each, Box of 10, etc. May also be called Pack Size. See UnitOfMeasure definition.  

quantity

decimal

ReceiptLine Quantity

 

X

 

 

 

Quantity associated with the receipt. Default to 1  

initialPrice

decimal

ReceiptLine Initial Price

 

 

 

 

 

The initial price of the Commodity used on the Receipt Line (e.g. before discounts). In Receipt Line currency.  

pricelist

priceList

ReceiptLine PriceList

 

X

 

 

reference 

A reference to the Price List used to derive the price on the Receipt Line. See PriceList definition.  

receiptLineDiscountType

discountType

ReceiptLine Receipt Line Discount Type

 

X

 

 

 

Flag to indicate the type of discount applicable to this Receipt Line (percent or amount)  

receiptLineDiscountAmount

decimal

ReceiptLine Receipt Line Discount Amount

 

X

 

 

 

Discount applicable to the Receipt Line, expressed as an amount.  

receiptLineDiscountPercent

decimal

ReceiptLine Receipt Line Discount Percent

 

X

 

 

 

Discount applicable to the Receipt Line, expressed as a percentage.  

actualPrice

decimal

ReceiptLine Actual Price

 

 

 

 

 

The actual price of the Commodity on the Receipt Line (e.g. after discounts or adjustments).  

netTotal

decimal

ReceiptLine Net Total

 

X

 

 

 

The (net/actual) amount of the Receipt Line. In Receipt Currency.  

discountTotal

decimal

ReceiptLine Discount Total

 

X

 

 

 

The value of any discount that has been taken off the Receipt Line. In Receipt Currency.  

chargesTotal

decimal

ReceiptLine Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Receipt Line (e.g. finance charges, interest). In Receipt Currency.  

priceTax

decimal

ReceiptLine Price Tax

 

X

 

 

 

Tax applicable to the Receipt Line price, e.g. the per unit tax. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

taxTotal

decimal

ReceiptLine Tax Total

 

X

 

 

 

The value of any tax that has been included in the Receipt Line. Both unit-tax and Line-tax values are required due to the way tax is handled differently by product/country.  

grossTotal

decimal

ReceiptLine Gross Total

 

X

 

 

 

The value of the Receipt Line if tax and discounts are included (e.g. the actual amount received). In Receipt Currency.  

name

normalizedString

ReceiptLine Name

 

X

 

 

 

Name of the Receipt Line. 

description

normalizedString

ReceiptLine Description

 

X

 

 

 

A description or narrative associated with the Receipt Line.  

financialAccounts

financialAccount*

ReceiptLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Receipt Line. See FinancialAccount definition.  

costCentres

costCentre*

ReceiptLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Receipt Line. See Cost Centre definition.  

departments

department*

ReceiptLine Departments

 

X

 

 

association 

Department(s) associated with this Receipt Line. See Department definition.  

project

project

ReceiptLine Project

 

X

 

 

reference 

Identifier of the Project this Receipt Line is for. See Project definition.  

projectLine

projectLine

ReceiptLine ProjectLine

 

X

 

 

reference 

Project Line value for this Receipt Line. See ProjectLine definition. Some applications may not have Project Lines.  

notes

note*

ReceiptLine Note

 

X

 

 

child 

Notes associated with the Receipt Line. 

Top  

Resource payment

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Payment Active Flag

 

 

 

 

 

Flag to indicate if the Payment is an active one. Default = True  

type

normalizedString

Payment Type

 

X

 

 

 

Type of the Payment (e.g. pre-payment, payment on account, etc).  

bankAccount

bankAccount

Payment BankAccount

 

X

 

 

reference 

Bank Account to which the Payment was made. See BankAccount definition.  

source

normalizedString

Payment Source

 

X

 

 

 

Source of the Payment (e.g. BACS/ACH, check, cash, direct debit).  

status

normalizedString

Payment Status

 

X

 

 

 

Status of the Payment (e.g. cleared, pending, authorized etc).  

tenderType

normalizedString

Payment Tender Type

 

X

 

 

 

The tendering method used for the Payment (e.g. cash, check, credit card (VISA, Amex, etc), bank transfer, commercial papers etc).  

tenderReference

normalizedString

Payment Tender Reference

 

X

 

 

 

Reference for the Payment associated with the tender type (e.g. check number, credit card number, etc).  

externalReference

normalizedString

Payment Tender External Reference

 

X

 

 

 

Reference for the Payment associated with the processor of the tender type.  

reference

normalizedString

Payment Reference

X

 

 

 

 

Reference for the Payment. 

reference2

normalizedString

Payment Reference2

 

X

 

 

 

Additional reference for the Payment. 

date

date

Payment Date

 

X

 

 

 

The date of the Payment. 

processDate

date

Payment Process Date

 

X

 

 

 

The date the Payment was processed, e.g. by the Bank Account (if different). Could be same as Payment Date  

tradingAccount

tradingAccount

Payment TradingAccount

 

X

 

 

reference 

Trading Account (e.g. Supplier/Customer) to which the Payment was made. See TradingAccount definition. Not mandatory as Payment can also be against a Financial Account.  

originatorDocuments

paymentOriginatorDocument*

Payment Originator Document References

 

X

 

 

association 

Reference to other documents if the Payment is for that document (e.g. a Purchase Invoice). If there are multiple (i.e. a Payment is for many Purchase Invoices) then this will be set on the Payment Line.  

taxCodes

taxCode*

Payment Tax Codes

 

X

 

 

association 

Tax code governing the tax regime applicable to this Payment. See TaxCode definition.  

user

normalizedString

Payment User

 

X

 

 

 

User associated with the Payment. The user resource will be defined in the future.  

currency

normalizedString

Payment Currency

 

 

 

 

 

The currency of the Payment (e.g. GBP, USD, EUR). ISO 4217. Default = Bank Account Currency.  

operatingCompanyCurrency

normalizedString

Payment OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Payment OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Payment Currency into Payment OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Payment OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Payment Currency to Payment OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Payment Values in Payment Currency / Payment Operating Company Currency Exchange Rate = Payment Values in Payment OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Payment OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Payment Currency to Payment OperatingCompany Currency, if different. Default = System date  

paymentFromBankAccount

bankAccount

Payment From BankAccount

 

X

 

 

reference 

Bank Account from which the Payment was made. See BankAccount definition.  

bankAccountCurrency

normalizedString

Payment Bank Account Currency

 

 

 

 

 

The currency used by the paying bank account. ISO 4217.  

bankAccountCurrencyExchangeRate

decimal

Payment Bank Account Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Payment Currency into Bank Account Currency, if different.  

bankAccountCurrencyExchangeRateOperator

rateOperator

Payment Bank Account Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Payment Bank Account Currency to Payment Currency. * (multiplication) or / division. E.g. if the operator is division then it is Payment Values in Payment Currency / Payment Bank Account Currency Exchange Rate = Payment Values in Payment Bank Account Currency.  

bankAccountCurrencyExchangeRateDate

date

Payment Bank Account Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Payment Currency to Payment OperatingCompany Currency, if different. Default = System date  

balanceBefore

decimal

Payment BankAccount Balance Before

 

X

 

 

 

The balance of the Bank Account making the Payment before the amount is applied. In Payment Currency.  

balanceAfter

decimal

Payment BankAccount Balance After

 

X

 

 

 

The balance of the Bank Account making the Payment after the actual amount is applied. In Payment Currency.  

discountTotal

decimal

Payment Discount Total

 

X

 

 

 

The value of any discount that has been taken off the Payment. In Payment Currency.  

chargesTotal

decimal

Payment Charges Total

 

X

 

 

 

Total value of any (sur)charges applied to the Payment (e.g. finance charges, interest).  

taxTotal

decimal

Payment Tax Total

 

X

 

 

 

The value of any tax that has been included in the Payment. In Payment Currency.  

grossTotal

decimal

Payment Gross Total

 

X

 

 

 

The value of the Payment including tax and discounts/charges. In Payment Currency.  

netTotal

decimal

Payment Net Total

 

X

 

 

 

The value of the Payment including discounts/charges, excluding tax. In Payment Currency.  

name

normalizedString

Payment Name

 

X

 

 

 

Name of the Payment. 

description

normalizedString

Payment Description

 

X

 

 

 

A description or narrative associated with the Payment.  

text1

string

Payment Text1

 

X

 

 

 

Text/commentary (e.g. special picking/packing instructions) for the Payment. Header text  

text2

string

Payment Text2

 

X

 

 

 

Text/commentary (e.g. special picking/packing instructions) for the Payment. Footer text  

paymentLines

paymentLine*

Payment Lines

 

X

 

 

child 

Payment Line detail. Lines are used when Payment are allocated across multiple invoices, financial accounts or Project. See PaymentLine definition. Not mandatory as some applications do not have Payment Lines.  

lineCount

decimal

Payment Line Count

 

X

 

 

 

The number of lines on the Payment. Should be auto-populated. Used as a cross reference to ensure integrity.  

financialAccounts

financialAccount*

Payment FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Payment. See FinancialAccount definition.  

costCentres

costCentre*

Payment CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Payment. See Cost Centre definition.  

departments

department*

Payment Departments

 

X

 

 

association 

Department(s) associated with this Payment. See Department definition.  

projects

project*

Payment Project

 

X

 

 

association 

Identifier of the Project this Payment is for. See Project definition. Payment Line values may be used instead.  

projectLines

projectLine*

Payment ProjectLine

 

X

 

 

association 

Project Line value for this Payment. See ProjectLine definition. Payment Line values may be used instead. Some applications may not have Project Lines.  

interactions

interaction*

Payment Interactions

 

X

 

 

association 

Interaction(s) associated with the payment. See Interaction definition.  

notes

note*

Payment Note

 

X

 

 

child 

Notes associated with the Payment. 

tenderTransactionType

tenderTransactionType

Payment Tender Transaction Type

 

X

 

 

 

The type of transaction associated with the receipt tender (e.g. credit card) e.g. credit card receipt, credit card authenticate (only),  

statusText

string

Payment Status Text

 

X

 

 

 

Human readable text associated with the status 

tenderTransactionAuthNo

decimal

Payment Tender Transaction Auth No

 

X

 

 

 

The Sage Pay authorisation code (also called VPSAuthCode) for this transaction. Sage Pay name is TXAuthNo. 

tenderRelatedExternalReference

string

Payment Tender Related External Reference

 

X

 

 

 

Transaction ID the original Transaction (e.g. if this is a refund against a previous transaction). 

tenderRelatedReference2

string

Payment Tender Related Reference 2

 

X

 

 

 

Another reference to the original Transaction (e.g. if this is a refund against a previous transaction). 

tenderRelatedTenderSecurityKey

string

Payment Related Tender Security Key

 

X

 

 

 

the Security key to be used to generate an MD5 Hash to sign the original transaction.  

tenderRelatedTenderTransactionAuthNo

decimal

Payment Related Tender Transaction Auth No

 

X

 

 

 

The Original transaction Sage Pay authorisation code (also called VPSAuthCode) for this transaction. Sage Pay name is TXAuthNo. 

operatingCompany

operatingCompany

Payment OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the payment (refund).  

Top  

Resource paymentLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

payment

payment

PaymentLine Payment

 

 

 

X

parent 

The Payment this Payment Line is for. See Payment definition.  

active

boolean

PaymentLine Active Flag

 

 

 

 

 

Flag to indicate if the Payment Line is an active one. Default = True  

reference

normalizedString

PaymentLine Reference

X

 

 

 

 

Reference for the Payment Line (e.g. check or BACS number).  

reference2

normalizedString

PaymentLine Reference2

 

X

 

 

 

Additional reference for the Payment Line (e.g. check or BACS number).  

number

decimal

PaymentLine Number

 

 

 

 

 

The number of the Payment Line. For sequencing and ordering of lines.  

date

date

PaymentLine Date

 

X

 

 

 

The date of the Payment Line. May be different to the Payment date if the Payment is allocated at a later date.  

originatorDocuments

paymentLineOriginatorDocument*

PaymentLine Originator Document References

 

X

 

 

association 

Reference to other documents if the Payment Line is for that document (e.g. a Purchase Invoice). A single Payment can be for many documents/invoices. See PurchaseInvoiceLine definition.  

originatorDocumentLines

paymentLineOriginatorDocumentLine*

PaymentLine Originator Document Line References

 

X

 

 

association 

Reference to other document Lines if the Payment Line is for that document Line (e.g. a Purchase Invoice Line). A single Payment can be for many documents/invoices. See PurchaseInvoiceLine definition.  

quantity

decimal

PaymentLine Quantity

 

 

 

 

 

Quantity associated with the payment. Default to 1  

discountTotal

decimal

PaymentLine Discount Total

 

X

 

 

 

The value of any discount that has been taken off the Payment Line. In Payment Currency.  

chargesTotal

decimal

PaymentLine Charges Total

 

X

 

 

 

The total value of any (sur)charges applied to the Payment Line.  

taxTotal

decimal

PaymentLine Tax Total

 

X

 

 

 

The value of any tax that has been included in the Payment Line. In Payment Currency.  

grossTotal

decimal

PaymentLine Gross Total

 

X

 

 

 

The value of the Payment Line including tax and discounts/charges (e.g. the amount paid). In Payment Currency.  

netTotal

decimal

PaymentLine Net Total

 

X

 

 

 

The value of the Payment Line including discounts/charges, excluding tax. In Payment Currency.  

name

normalizedString

PaymentLine Name

 

X

 

 

 

Name of the Payment Line. 

description

normalizedString

PaymentLine Description

 

X

 

 

 

A description or narrative associated with the Payment Line.  

financialAccounts

financialAccount*

PaymentLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Payment Line. See FinancialAccount definition.  

costCentres

costCentre*

PaymentLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Payment Line. See Cost Centre definition.  

departments

department*

PaymentLine Departments

 

X

 

 

association 

Department(s) associated with this Payment Line. See Department definition.  

project

project

PaymentLine Project

 

X

 

 

reference 

Identifier of the Project this Payment Line is for. See Project definition.  

projectLine

projectLine

PaymentLine ProjectLine

 

X

 

 

reference 

Project Line value for this Payment Line. See ProjectLine definition. Some applications may not have Project Lines.  

notes

note*

PaymentLine Note

 

X

 

 

child 

Notes associated with the Payment Line. 

Top  

Resource project

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Project Active Flag

 

 

 

 

 

Flag to indicate if the Project is an active one. Default = True  

reference

normalizedString

Project Reference

X

 

 

 

 

Reference for the Project. 

reference2

normalizedString

Project Reference2

 

X

 

 

 

Additional reference for the Project. 

type

normalizedString

Project Type

 

X

 

 

 

The type of the Project (e.g. chargeable, internal, etc).  

name

normalizedString

Project Name

 

X

 

X

 

Name of the Project. 

shortName

normalizedString

Project Short Name

 

X

 

 

 

A shorter name for the Project. 

description

normalizedString

Project Description

 

X

 

 

 

A longer description of the Project. 

status

normalizedString

Project Status

 

X

 

 

 

Status of the Project. 

completionStatus

normalizedString

Project Completion Status

 

X

 

 

 

Additional status flag for use against the completion of the Project (e.g. %age complete).  

startDate

date

Project Start Date

 

X

 

 

 

Date the Project was started. 

endDate

date

Project End Date

 

X

 

 

 

Date the Project was finished. 

originalEndDate

date

Project Original End Date

 

X

 

 

 

Original end date for the Project, if slipped. 

forecastEndDate

date

Project Forecast End Date

 

X

 

 

 

Forecast end date for the Project, if not already finished.  

duration

duration

Project Duration

 

X

 

 

 

The duration of the Project. 

tradingAccounts

tradingAccount*

Project Customer TradingAccounts

 

X

 

 

association 

Trading Account associated with the Customer the Project is for, if any. The Trading Account will handle any sales transactions associated with the Project (e.g. Sales Orders & Invoices). See TradingAccount definition.  

currency

normalizedString

Project Currency

 

 

 

 

 

The Project currency (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

Project OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Project OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Project Currency into Project OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Project OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Project Currency to Project OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Project Values in Project Currency / Project Operating Company Currency Exchange Rate = Project Values in Project OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Project OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Project Currency to Project OperatingCompany Currency, if different. Default = System date  

originatorDocument

projectOriginatorDocument--choice

Project Originator Document Reference

 

X

 

 

reference 

Reference to a document (e.g. Sales Order) used to originate the Project. See SalesOrder definition.  

associatedProject

project

Project Associated Project

 

X

 

 

reference 

Link to another Project associated with this one (e.g. if the Project is copied from another then this will be a reference to the original). See Project definition.  

parentProject

project

Project Parent Project

 

X

 

 

parent 

Link to a Project which is the Parent of this Project.  

childProjects

project*

Project Child Project

 

X

 

 

child 

Link to any Projects that this Project is the parent of.  

projectLines

projectLine*

Project ProjectLine

 

X

 

 

child 

Lines associated with the Project. See ProjectLine definition Some applications may not have Project Lines.  

currentCostBalance

decimal

Project Current Cost Balance

 

X

 

 

 

Current Cost balance on the Project. 

lastCostTransactionDate

date

Project Last Cost Transaction Date

 

X

 

 

 

Date the last cost transaction was posted to the Project (e.g. date of the Cost Balance).  

currentRevenueBalance

decimal

Project Current Revenue Balance

 

X

 

 

 

Current Revenue balance on the Project. 

lastRevenueTransactionDate

date

Project Last Revenue Transaction Date

 

X

 

 

 

Date the last cost transaction was posted to the Project (e.g. date of the Cost Balance).  

currentCostBudget

decimal

Project Current Cost Budget

 

X

 

 

 

Current Cost budget on the Project. 

currentCostBudgetDate

date

Project Current Cost Budget Date

 

X

 

 

 

Date the budget was last changed (e.g. date of the Cost Budget).  

currentRevenueBudget

decimal

Project Current Revenue Budget

 

X

 

 

 

Current Revenue budget on the Project. 

currentRevenueBudgetDate

date

Project Current Revenue Budget Date

 

X

 

 

 

Date the budget was last changed (e.g. date of the Revenue Budget).  

currentCommittedCostBalance

decimal

Project Current Committed Cost Balance

 

X

 

 

 

Current committed Cost balance on the Project. 

currentCommittedCostBalanceDate

date

Project Current Committed Cost Balance Date

 

X

 

 

 

Date the last committed cost transaction was posted to the Project (e.g. date of the Committed Cost Balance).  

contacts

contact*

Project Contact

 

X

 

 

association 

Contact(s) associated with the Project. See Contact definition.  

postalAddresses

postalAddress*

Project PostalAddress

 

X

 

 

child 

Address of the Project. See PostalAddress definition.  

taxCodes

taxCode*

Project Tax Code

 

X

 

 

association 

Tax code governing the tax regime applicable to this Project. See TaxCode definition.  

financialAccounts

financialAccount*

Project FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Project. See FinancialAccount definition.  

costCentres

costCentre*

Project CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Project. See Cost Centre definition.  

departments

department*

Project Departments

 

X

 

 

association 

Department(s) associated with this Project. See Department definition.  

interactions

interaction*

Project Interactions

 

X

 

 

association 

Interaction(s) associated with the Project. See Interaction definition.  

cases

case*

Project Case

 

X

 

 

association 

Case(s) associated with the Project, e.g. if the Project is for repair/services. See Project definition.  

notes

note*

Project Note

 

X

 

 

child 

Notes associated with the Project. 

Top  

Resource projectLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

project

project

ProjectLine Project

 

 

 

X

parent 

Project this Line is for. See Project definition.  

active

boolean

ProjectLine Active Flag

 

 

 

 

 

Flag to indicate if the Project Line is an active one. Default = True  

isGroupingFlag

boolean

ProjectLine Is Grouping Flag

 

X

 

 

 

Flag to indicate if this Project Line is a grouping Line, e.g. used for aggregating Project Lines (e.g. a Phase). Default = False  

reference

normalizedString

ProjectLine Reference

X

 

 

 

 

Reference for the Project Line. 

reference2

normalizedString

ProjectLine Reference2

 

X

 

 

 

Additional reference for the Project Line. 

number

decimal

ProjectLine Number

 

 

 

 

 

The number of the Project Line. For sequencing and ordering of lines.  

type

normalizedString

ProjectLine Type

 

X

 

 

 

The type of the Project Line (e.g. labour, materials, etc).  

name

normalizedString

ProjectLine Name

 

X

 

X

 

Name of the Project Line. 

shortName

normalizedString

ProjectLine Short Name

 

X

 

 

 

A shorter name for the Project Line. 

description

normalizedString

ProjectLine Description

 

X

 

 

 

A longer description of the Project Line. 

status

normalizedString

ProjectLine Status

 

X

 

 

 

Status of the Project Line. 

completionStatus

normalizedString

ProjectLine Completion Status

 

X

 

 

 

Additional status flag for use against the completion of the Project Line (e.g. %age complete).  

startDate

date

ProjectLine Start Date

 

X

 

 

 

Date the Project Line was started. 

endDate

date

ProjectLine End Date

 

X

 

 

 

Date the Project Line was finished. 

originalEndDate

date

ProjectLine Original End Date

 

X

 

 

 

Original end date for the Project Line, if slipped.  

forecastEndDate

date

ProjectLine Forecast End Date

 

X

 

 

 

Forecast end date for the Project Line, if not already finished.  

duration

duration

ProjectLine Duration

 

X

 

 

 

The duration of the Project Line. 

originatorDocumentLine

projectLineOriginatorDocumentLine--choice

ProjectLine Originator Document Line Reference

 

X

 

 

reference 

Reference to a document line (e.g. Sales Order Line) used to originate the Project Line.  

associatedProjectLine

projectLine

ProjectLine Associated ProjectLine

 

X

 

 

reference 

Link to another Project Line associated with this one (e.g. if the Project Line is copied from another then this will be a reference to the original). See ProjectLine definition.  

currentCostBalance

decimal

ProjectLine Current Cost Balance

 

X

 

 

 

Current Cost balance on the Project Line. 

lastCostTransactionDate

date

ProjectLine Last Cost Transaction Date

 

X

 

 

 

Date the last cost transaction was posted to the Project Line (e.g. date of the Cost Balance).  

currentRevenueBalance

decimal

ProjectLine Current Revenue Balance

 

X

 

 

 

Current Revenue balance on the Project Line. 

lastRevenueTransactionDate

date

ProjectLine Last Revenue Transaction Date

 

X

 

 

 

Date the last cost transaction was posted to the Project Line (e.g. date of the Cost Balance).  

currentCostBudget

decimal

ProjectLine Current Cost Budget

 

X

 

 

 

Current Cost budget on the Project Line. 

currentCostBudgetDate

date

ProjectLine Current Cost Budget Date

 

X

 

 

 

Date the budget was last changed (e.g. date of the Cost Budget).  

currentRevenueBudget

decimal

ProjectLine Current Revenue Budget

 

X

 

 

 

Current Revenue budget on the Project Line. 

currentRevenueBudgetDate

date

ProjectLine Current Revenue Budget Date

 

X

 

 

 

Date the budget was last changed (e.g. date of the Revenue Budget).  

currentCommittedCostBalance

decimal

ProjectLine Committed Cost Balance

 

X

 

 

 

Current committed Cost balance on the Project Line.  

currentCommittedCostBalanceDate

date

ProjectLine Current Committed Cost Balance Date

 

X

 

 

 

Date the last committed cost transaction was posted to the Project Line (e.g. date of the Committed Cost Balance).  

accountingType

projectLineAccountingType

ProjectLine Accounting Type

 

X

 

 

 

Accounting type applicable to the Project Line (e.g. expense, revenue, etc).  

financialAccounts

financialAccount*

ProjectLine FinancialAccounts

 

X

 

 

association 

Financial accounting code applicable to the Project Line. See FinancialAccount definition.  

costCentres

costCentre*

ProjectLine CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Project Line. See Cost Centre definition.  

departments

department*

ProjectLine Departments

 

X

 

 

association 

Department(s) associated with this Project Line. See Department definition.  

notes

note*

ProjectLine Notes

 

X

 

 

child 

Notes associated with the Project Line. 

Top  

Resource bankAccount

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

BankAccount Active Flag

 

 

 

 

 

Flag to indicate if the Bank Account is an active one. Default = True  

type

normalizedString

BankAccount Type

 

X

 

 

 

The Bank Account type (current, deposit, credit card, etc).  

reference

normalizedString

BankAccount Reference

X

 

 

 

 

Reference for the Bank Account. 

name

normalizedString

BankAccount Name

 

X

 

 

 

Name of the Bank Account. 

description

normalizedString

BankAccount Description

 

X

 

 

 

A longer description of the Bank Account. 

branchIdentifier

normalizedString

BankAccount Branch Identifier

 

X

 

 

 

The bank branch identifier (e.g. sort code, code guichet) of the bank holding the Bank Account.  

accountNumber

normalizedString

BankAccount Account Number

 

X

 

 

 

The Bank Account number (or credit card number). 

ibanNumber

normalizedString

BankAccount IBAN Number

X

X

 

 

 

The international bank account number (IBAN) for the Bank Account. ISO 13616:2003  

bicSwiftCode

normalizedString

BankAccount BIC Swift Code

 

X

 

 

 

The international bank identifier code (BIC) for the bank holding the Bank Account. ISO 9362  

rollNumber

normalizedString

BankAccount Roll Number

 

X

 

 

 

Additional reference number for this account (used by some types of UK banks).  

currency

normalizedString

BankAccount Currency

 

 

 

 

 

The currency of the Bank Account (e.g. GBP, USD, EUR). ISO 4217.  

operatingCompanyCurrency

normalizedString

BankAccount OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

tradingAccount

tradingAccount

BankAccount Trading Account

 

X

 

 

reference 

The Trading Account associated with the Bank Account (if Customer Supplier Flag = Customer or Supplier). See TradingAccount definition.  

contacts

contact*

BankAccount Contact

 

X

 

 

association 

Details of the Contact at the bank associated with the Bank Account (e.g. bank manager). See Contact definition.  

phones

phoneNumber*

BankAccount Phone

 

X

 

 

association 

Telephone number(s) of the bank holding the Bank Account.. See PhoneNumber definition.  

emails

email*

BankAccount Email

 

X

 

 

association 

Email address of the bank holding the Bank Account.. See Email definition.  

website

normalizedString

BankAccount Web Site

 

X

 

 

 

Web site address of the bank holding the Bank Account..  

postalAddress

postalAddress

BankAccount PostalAddress

 

X

 

 

child 

PostalAddress of the bank holding the Bank Account. See PostalAddress definition.  

companyReference

normalizedString

BankAccount Company Reference

 

X

 

 

 

Reference used by the bank holding the Bank Account for the Company associated with the Bank Account (e.g. OperatingCompany, Customer, Supplier, etc).  

paymentAllowedFlag

boolean

BankAccount Payment Allowed Flag

 

X

 

 

 

Flag to indicate if Payment are allowed to be made from this Bank Account. Default is True.  

paymentReference

normalizedString

BankAccount Payment Reference

 

X

 

 

 

Additional reference field for the Bank Account to be used when making Payment (to the Bank Account).  

receiptAllowedFlag

boolean

BankAccount Receipt Allowed Flag

 

X

 

 

 

Flag to indicate if Receipt are allowed to be made to this Bank Account. Default is True.  

receiptReference

normalizedString

BankAccount Receipt Reference

 

X

 

 

 

Additional reference field for the Bank Account to be used when creating Receipt (from the Bank Account) such as direct debits.  

reference2

normalizedString

BankAccount Reference2

 

X

 

 

 

Additional reference field for the Bank Account. 

balance

decimal

BankAccount Balance

 

X

 

 

 

Current balance of the Bank Account. 

limit

decimal

BankAccount Limit

 

X

 

 

 

Limit (e.g. overdraft limit) applicable to the Bank Account.  

financialAccounts

financialAccount*

BankAccount Financial Account

 

X

 

 

association 

Financial account associated with the Bank Account (e.g. the cash asset account). See Financial Account definition  

costCentres

costCentre*

BankAccount CostCentres

 

X

 

 

association 

Cost Centre(s) associated with this Bank Account. See Cost Centre definition.  

departments

department*

BankAccount Departments

 

X

 

 

association 

Department(s) associated with this Bank Account. See Department definition.  

lastStatementDate

date

BankAccount Last Statement Date

 

X

 

 

 

Date of the last statement in connection with the Bank Account (e.g. the date of the balance).  

primacyIndicator

boolean

BankAccount Primacy Indicator

 

 

 

 

 

Flag to indicate if this Bank Account is the primary one associated with the linked resource. Default = False  

notes

note*

BankAccount Note

 

X

 

 

child 

Notes associated with the Bank Account. 

Top  

Resource location

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Location Active Flag

 

 

 

 

 

Flag to indicate if the Location is an active one. Default = True  

type

normalizedString

Location Type

 

X

 

 

 

Warehouse, bin, zone, etc. 

reference

normalizedString

Location Reference

X

 

 

 

 

Reference associated with the Location. 

reference2

normalizedString

Location Reference2

 

X

 

 

 

Another reference associated with the Location. 

name

normalizedString

Location Name

 

 

 

X

 

Name of the Location. 

description

normalizedString

Location Description

 

X

 

 

 

A longer description of the Location. 

customerSupplierFlag

supplierFlag

Location Customer Supplier Flag

 

X

 

 

 

A flag to indicate if the Location is for a Customer or Supplier. If Location is for internal use only (i.e. a warehouse) then use Neither  

postalAddress

postalAddress

Location PostalAddress

 

X

 

 

child 

Link to the Location address. See PostalAddress definition.  

saleFlag

boolean

Location Sale Flag

 

X

 

 

 

Flag to indicate if the Location is used for Sales (e.g. a Sales fulfillment Location).  

purchaseFlag

boolean

Location Purchase Flag

 

X

 

 

 

Flag to indicate if the Location is used for Purchases (e.g. a Delivery Location).  

openingDays

normalizedString

Location Opening Days

 

X

 

 

 

Details of opening times for the Location, e.g. when deliveries can be accepted.  

openingTimes

dateTime

Location Opening Times

 

X

 

 

 

Details of opening times for the Location, e.g. when deliveries can be accepted.  

gpsPosition

normalizedString

Location GPS Position

 

X

 

 

 

A GPS position for the Location (useful for web or sat nav mobile device integration).  

phones

phoneNumber*

Location Phone

 

X

 

 

association 

Location telephone number(s). See PhoneNumber definition.  

emails

email*

Location Email

 

X

 

 

association 

Location email address(es). See Email definition.  

website

normalizedString

Location Web Site

 

X

 

 

 

Location web site address. 

contacts

contact*

Location Contact

 

X

 

 

association 

Link to the Contact(s) associated with the Location (e.g. warehouse manager). See Contact definition.  

transitFlag

boolean

Location Transit Flag

 

X

 

 

 

Flag to indicate if the Location is a transit Location (e.g. does not hold Commodity). Yes, the Location is a transit Location, no (default), the Location is not a transit Location.  

notes

note*

Location Note

 

X

 

 

child 

Notes associated with a Location (e.g. for credit control).  

parentLocation

location

Location Parent Location

 

X

 

 

parent 

Link to a Location which is the Parent of this Location (e.g. bins within zones within warehouses etc).  

childLocations

location*

Location Child Locations

 

X

 

 

child 

Link to any Locations that this Location is the parent of.  

Top  

Resource commodityIdentifier

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

CommodityIdentifier Active Flag

 

 

 

 

 

Flag to indicate if the Commodity Identifier is an active one. Default = True  

reference

normalizedString

CommodityIdentifier Reference

X

 

 

 

 

Reference associated with the Commodity Identifier.  

reference2

normalizedString

CommodityIdentifier Reference2

 

X

 

 

 

Another reference associated with the Commodity Identifier.  

isUniqueFlag

boolean

CommodityIdentifier Unique Flag

 

 

 

 

 

Flag to indicate if this Commodity Identifier is unique, or if duplicates are allowed. Default No (duplicates are allowed).  

status

normalizedString

CommodityIdentifier Status

 

X

 

 

 

Status of the Commodity Identifier. 

type

commodityIdentifierType

CommodityIdentifier Type

 

X

 

 

 

Type of the Commodity Identifier (e.g. Total, Batch (lot), Serial Number).  

inStockFlag

boolean

CommodityIdentifier In Stock Flag

 

X

 

 

 

Flag to indicate if the Commodity identifier is in stock. For serial items true will mean the serial numbered item is in stock (not sold). For Batch and Total items this will mean there is still some in stock.  

name

normalizedString

CommodityIdentifier Name

 

X

 

 

 

Name of the Commodity identifier. 

description

normalizedString

CommodityIdentifier Description

 

X

 

 

 

A longer description of the Commodity Identifier. 

commodity

commodity

CommodityIdentifier Commodity

 

 

 

X

parent 

The Commodity this Commodity Identifier is for. See Commodity definition.  

variant

commodityVariant

CommodityIdentifier Variant

 

X

 

 

reference 

The Variant of the Commodity Identifier (e.g. colour or size). See Variant definition.  

dimension

commodityDimension

CommodityIdentifier Dimension

 

X

 

 

reference 

The physical Dimension of the Commodity identifier (e.g. height). See Dimension definition.  

identifier

normalizedString

CommodityIdentifier Identifier

 

X

 

 

 

The identifier for the Commodity, e.g. the serial number or the batch (lot) number for the Commodity (or the Commodity / Variant / Dimension combination).  

barcode

normalizedString

CommodityIdentifier Barcode

 

X

 

 

 

UPC/EAN code for the Commodity Identifier. 

creationDate

date

CommodityIdentifier Creation Date

 

X

 

 

 

The date the Commodity Identifier was generated. 

useByDate

date

CommodityIdentifier Use By Date

 

X

 

 

 

The date the Commodity Identifier is to be used by.  

expirationDate

date

CommodityIdentifier Expiration Date

 

X

 

 

 

The date the Commodity Identifier expires. 

parentCommodityIdentifier

commodityIdentifier

CommodityIdentifier Parent Commodity Identifier

 

X

 

 

parent 

Link to a Commodity Identifier which is the Parent of this Commodity Identifier (e.g. serial numbers within batches within lots, etc).  

childCommodityIdentifiers

commodityIdentifier*

CommodityIdentifier Child Commodity Identifier

 

X

 

 

child 

Link to any Commodity Identifiers that this Commodity Identifier is the parent of.  

buyingAllowed

boolean

CommodityIdentifier Buying Allowed Flag

 

X

 

 

 

Flag to indicate that this Commodity Identifier can be bought i.e. can be used on purchase orders/requisitions. Could default from Commodity  

supplierTradingAccount

tradingAccount

CommodityIdentifier Supplier Trading Account

 

X

 

 

reference 

Link to the Supplier Trading account associated with this Commodity Identifier (if it was purchased). See TradingAccount definition.  

originatorPurchaseDocumentLines

commodityIdentifierOriginatorPurchaseDocumentLine*

CommodityIdentifier Originator Purchase Document Line References

 

X

 

 

association 

Link to the purchasing Lines associated with this Commodity Identifier. See PurchaseOrderLine definition.  

purchaseDeliveryLine

purchaseOrderDeliveryLine

CommodityIdentifier PurchaseOrderDeliveryLine

 

X

 

 

reference 

Link to the Purchase Order Delivery Line associated with this Commodity Identifier. See PurchaseOrderDeliveryLine definition.  

purchaseQuantity

decimal

CommodityIdentifier Purchase Quantity

 

X

 

 

 

Quantity of the Commodity Identifier purchased. 

lastPurchaseDate

date

CommodityIdentifier Last Purchase Date

 

X

 

 

 

Date of the last purchase of the Commodity Identifier.  

sellingAllowed

boolean

CommodityIdentifier Selling Allowed Flag

 

X

 

 

 

Flag to indicate that this Commodity Identifier can be sold i.e. can be used on sales orders/quotations. Could default from Commodity.  

customerTradingAccount

tradingAccount

CommodityIdentifier Customer Trading Account

 

X

 

 

reference 

Link to the Customer Trading account associated with this Commodity Identifier (if it was purchased). See TradingAccount definition.  

originatorSalesDocumentLines

commodityIdentifierOriginatorSalesDocumentLine*

CommodityIdentifier Originator Sales Document Line References

 

X

 

 

association 

Link to the Sales Line(s) associated with this Commodity Identifier. See SalesOrderLine definition.  

salesDeliveryLines

salesOrderDeliveryLine*

CommodityIdentifier SalesOrderDeliveryLines

 

X

 

 

association 

Link to the Sales Order Delivery Line associated with this Commodity Identifier. See SalesOrderDeliveryLine definition.  

saleQuantity

decimal

CommodityIdentifier Sale Quantity

 

X

 

 

 

Quantity of the Commodity Identifier sold. 

lastSaleDate

date

CommodityIdentifier Last Sale Date

 

X

 

 

 

Date of the last sale of the Commodity Identifier.  

movementAllowed

boolean

CommodityIdentifier Movements Allowed Flag

 

X

 

 

 

Flag to indicate that this Commodity Identifier can be moved i.e. can be transferred or written-off. Default = Yes  

movementQuantity

decimal

CommodityIdentifier Movement Quantity

 

X

 

 

 

Quantity of the Commodity Identifier moved/transferred.  

lastMovementDate

date

CommodityIdentifier Last Movement Date

 

X

 

 

 

Date of the last movement of the Commodity Identifier.  

availableQuantity

decimal

CommodityIdentifier Available Quantity

 

 

 

 

 

Quantity of the Commodity Identifier available (e.g. sale).  

reservedQuantity

decimal

CommodityIdentifier Reserved Quantity

 

X

 

 

 

Quantity of the Commodity Identifier reserved/allocated (for e.g. sale).  

totalQuantity

decimal

CommodityIdentifier Total Quantity

 

 

 

 

 

Total Quantity of the Commodity Identifier available.  

location

location

CommodityIdentifier Location

 

X

 

 

reference 

Link to the (Parent) Location associated with this Commodity Identifier. See Location definition.  

subLocation

location

CommodityIdentifier Sub-Location

 

X

 

 

reference 

Link to the Sub-Location associated with this Commodity Identifier (e.g. bin/zone). For multi-dimensional locations, this should be the lowest level Location at which the Commodity identifier is stored. See Location definition.  

notes

note*

CommodityIdentifier Notes

 

X

 

 

child 

Notes associated with a Commodity Identifier (e.g. for credit control).  

Top  

Resource salesPerson

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

SalesPerson Active Flag

 

 

 

 

 

Flag to indicate if the SalesPerson is an active one. Default = True  

reference

normalizedString

SalesPerson Reference

X

 

 

 

 

Reference associated with the SalesPerson. 

reference2

normalizedString

SalesPerson Reference2

 

X

 

 

 

Another reference associated with the SalesPerson.  

name

normalizedString

SalesPerson Name

 

 

 

X

 

The name of the sales person. 

contact

contact

SalesPerson Contact

 

X

 

 

reference 

A link to the Contact (if any) used to store details about this sales person. See Contact definition.  

employee

person

SalesPerson Employee

 

X

 

 

reference 

A link to the Employee associated with this sales person. See Employee definition. Employees are defined in the HRM-ERP Schema.  

postalAddress

postalAddress

SalesPerson PostalAddress

 

X

 

 

child 

The Postal Address of the sales person. See PostalAddress definition.  

commissionType

salesPersonCommissionType

SalesPerson Commission Type

 

X

 

 

 

Flag to indicate the type of commission applicable to this sales person (percent or amount)  

commissionAmount

decimal

SalesPerson Commission Amount

 

X

 

 

 

Commission applicable to the sales person expressed as an amount.  

commissionPercent

decimal

SalesPerson Commission Percent

 

X

 

 

 

Commission applicable to the sales person expressed as a percent.  

primacyIndicator

boolean

SalesPerson Primacy Indicator

 

 

 

 

 

Flag to indicate if this Sales Person is the primary sales person. Default = False  

notes

note*

SalesPerson Note

 

X

 

 

child 

Notes associated with the Sales Person 

Top  

Resource commodityDimension

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Dimension Active Flag

 

 

 

 

 

Flag to indicate if the Dimension is an active one. Default = True  

reference

normalizedString

Dimension Reference

X

 

 

 

 

Reference associated with the Dimension. 

reference2

normalizedString

Dimension Reference2

 

X

 

 

 

Another reference associated with the Dimension. 

type

commodityDimensionType

Dimension Type

 

 

 

 

 

The type of the Dimension (e.g. height, width, depth, etc). Default = Unknown  

value

decimal

Dimension Value

 

 

 

 

 

The value associated with the Dimension 

commodities

commodity*

Dimension Commodity

 

X

 

 

association 

Link to the commodities associated with the Dimension. See Commodity definition.  

notes

note*

Dimension Note

 

X

 

 

child 

Note associated with the Dimension. See Note definition.  

Top  

Resource commodityVariant

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Variant Active Flag

 

 

 

 

 

Flag to indicate if the Variant is an active one. Default = True  

reference

normalizedString

Variant Reference

X

 

 

 

 

Reference associated with the Variant. 

reference2

normalizedString

Variant Reference2

 

X

 

 

 

Another reference associated with the Variant. 

type

commodityVariantType

Variant Type

 

 

 

 

 

The type of the Variant (e.g. colour, size, etc). Default = Unknown  

value

decimal

Variant Value

 

 

 

 

 

The value associated with the Variant 

commodities

commodity*

Variant Commodity

 

X

 

 

association 

Link to the Variant(s) associated with the Dimension. See Commodity definition.  

notes

note*

Variant Note

 

X

 

 

child 

Notes associated with the Variant. See Note definition.  

Top  

Resource case

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Case Active Flag

 

 

 

 

 

Flag to indicate if the Case is an active one. Default = True  

reference

normalizedString

Case Reference

X

 

 

 

 

Reference associated with the Case. 

reference2

normalizedString

Case Reference2

 

X

 

 

 

Another reference associated with the Case. 

type

normalizedString

Case Type

 

 

 

 

 

The type of the Case (e.g. service, repair, return, etc)  

name

normalizedString

Case Name

 

X

 

 

 

The name of the case. 

description

normalizedString

Case Description

 

X

 

 

 

A longer description of the case. 

associatedCases

case*

Case Associated Cases

 

X

 

 

association 

A link to other Case(s) associated with this one. 

status

caseStatus

Case Status

 

X

 

 

 

Status of the Case. 

completionStatus

normalizedString

Case Completion Status

 

X

 

 

 

Additional status flag for use against the completion of the Case (e.g. %age complete).  

startDate

date

Case Start Date

 

X

 

 

 

Date the Case was started. 

endDate

date

Case End Date

 

X

 

 

 

Date the Case was finished. 

originalEndDate

date

Case Original End Date

 

X

 

 

 

Original end date for the Case, if slipped. 

forecastEndDate

date

Case Forecast End Date

 

X

 

 

 

Forecast end date for the Case, if not already finished.  

duration

duration

Case Duration

 

X

 

 

 

The duration of the Case. 

customerTradingAccount

tradingAccount

Case Customer TradingAccount

 

X

 

 

reference 

Trading Account associated with the Customer the Case is for, if any. The Trading Account will handle any sales transactions associated with the Case (e.g. Sales Orders & Invoices). See TradingAccount definition.  

currency

normalizedString

Case Currency

 

 

 

 

 

The Case currency (e.g. GBP, USD, EUR). ISO 4217. 

operatingCompanyCurrency

normalizedString

Case OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the base currency). ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Case OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Case Currency into Case OperatingCompany Currency, if different.  

operatingCompanyCurrencyExchangeRateOperator

rateOperator

Case OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Case Currency to Case OperatingCompany Currency. * (multiplication) or / division. E.g. if the operator is division then it is Case Values in Case Currency / Case Operating Company Currency Exchange Rate = Case Values in Case OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Case OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Case Currency to Case OperatingCompany Currency, if different. Default = System date  

salesOrders

salesOrder*

Case SalesOrders

 

X

 

 

association 

A link to the sales order(s) generated for this case, if any. See SalesOrder definition.  

salesOrderDeliveries

salesOrderDelivery*

Case SalesOrderDelivery

 

X

 

 

association 

A link to the sales order Delivery(s) generated for this case, if any. See SalesOrderDelivery definition.  

salesInvoices

salesInvoice*

Case SalesInvoice

 

X

 

 

association 

A link to the Sales Invoice(s) generated for this case, if any. See SalesInvoice definition.  

currentRevenueBalance

decimal

Case Current Revenue Balance

 

X

 

 

 

Current Revenue balance on the Case. In Case currency.  

lastRevenueTransactionDate

date

Case Last Revenue Transaction Date

 

X

 

 

 

Date the last revenue transaction was posted to the Case (e.g. date of the Revenue Balance).  

supplierTradingAccount

tradingAccount

Case Supplier TradingAccount

 

X

 

 

reference 

Trading Account associated with the Supplier the Case is for, if any. The Trading Account will handle any sales transactions associated with the Case (e.g. Purchase Orders& Invoices). See TradingAccount definition.  

purchaseOrders

purchaseOrder*

Case PurchaseOrders

 

X

 

 

association 

A link to the Purchase order(s) generated for this case, if any. See PurchaseOrder definition.  

purchaseOrderDeliveries

purchaseOrderDelivery*

Case PurchaseOrderDelivery

 

X

 

 

association 

A link to the Purchase order Delivery(s) generated for this case, if any. See PurchaseOrderDelivery definition.  

purchaseInvoices

purchaseInvoice*

Case PurchaseInvoice

 

X

 

 

association 

A link to the Purchase Invoice(s) generated for this case, if any. See PurchaseInvoice definition.  

currentCostBalance

decimal

Case Current Cost Balance

 

X

 

 

 

Current Cost balance on the Case. In Case currency.  

lastCostTransactionDate

date

Case Last Cost Transaction Date

 

X

 

 

 

Date the last cost transaction was posted to the Case (e.g. date of the Cost Balance).  

contacts

contact*

Case Contact

 

X

 

 

association 

Contact(s) associated with the Case. See Contact definition.  

commodity

commodity

Case Commodity

 

X

 

 

reference 

Link to the Commodity associated with the Case, if any. See Commodity definition.  

commodityIdentifiers

commodityIdentifier*

Case CommodityIdentifier

 

X

 

 

association 

Link to the Commodity Identifier(s) for this Case, if it is traced to that level of detail. See CommodityIdentifier definition.  

project

project

Case Project

 

X

 

 

reference 

Identifier of any associated Project. See Project definition.  

workflowIndicator1

string

Case Workflow Indicator1

 

X

 

 

 

To support Case workflow. This attribute can be used to track, e.g. the position in the case cycle.  

workflowIndicator2

string

Case Workflow Indicator2

 

X

 

 

 

Additional attribute to support Case workflow. This attribute can be used to track, e.g. the stage in the case cycle.  

contract

string

Case Contract

 

X

 

 

 

Reference to a contract associated with the Case.  

priority

casePriority

Case Priority

 

X

 

 

 

The priority of the Case. 

privacyFlag

boolean

Case Privacy

 

X

 

 

 

Flag to indicate if the Case is private or public. Private typically means it is not available for Customer (or Supplier) self-service applications. Default = False  

interactions

interaction*

Case Interactions

 

X

 

 

association 

Interactions associated with the Case. See Interaction definition.  

notes

note*

Case Note

 

X

 

 

child 

Notes associated with the Case. See Note definition.  

Top  

Resource taxCode

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

TaxCode Active Flag

 

 

 

 

 

Flag to indicate if the TaxCode is an active one. Default = True  

reference

normalizedString

TaxCode Reference

X

 

 

 

 

Reference associated with the TaxCode. 

reference2

normalizedString

TaxCode Reference2

 

X

 

 

 

Another reference associated with the TaxCode. 

type

normalizedString

TaxCode Type

 

X

 

 

 

The type of the TaxCode (VAT, GST) 

taxationCountry

normalizedString

TaxCode Taxation Country

 

 

 

 

 

The country whose tax regime applies to this Tax Code. ISO 3166-1 alpha-2 country codes only  

taxationLocale

normalizedString

TaxCode Taxation Locale

 

X

 

 

 

The locale within the country whose tax regime applies to this Tax Code.  

value

decimal

TaxCode Value

 

 

 

 

 

The value associated with the TaxCode (e.g. 17.5, 0),  

valueText

normalizedString

TaxCode Value Text

 

 

 

 

 

A textual version of the Tax Code Value. In some jurisdictions (UK) a Tax Code may be a string (e.g. UK Employee Tax Codes). Default = string version of value above.  

primacyIndicator

boolean

TaxCode Primacy Indicator

 

 

 

 

 

Flag to indicate if this Tax Code is the primary Tax Code in cases where there are multiple. Default = False  

orderOfPrecedence

decimal

TaxCode Order Of Precedence

 

X

 

 

 

Where there are multiple tax codes then this field will be used to sort the order of precedence/application.  

notes

note*

TaxCode Notes

 

X

 

 

child 

Note associated with the TaxCode. See Note definition.  

Top  

Resource computePrice

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

request

computePriceRequest

Request

 

 

 

 

reference 

Pricing service request.  

response

computePriceResponse

Response

 

 

 

 

reference 

Pricing service response.  

Top  

Resource computePriceRequest

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

tradingAccount

tradingAccount

Trading Account

 

 

 

 

reference 

Link to the Trading Account (if any) associated with this pricing request.  

originatorDocument

computePriceOriginatorDocument--choice

Originator Document

 

 

 

 

reference 

Link to the document (if any) associated with this pricing request.  

date

dateTime

Pricing Document Date

 

 

 

 

 

The date the document associated with this pricing request was opened.  

status

normalizedString

Pricing Document Status

 

 

 

 

 

Status of the document associated with this pricing request.  

currency

normalizedString

Pricing Document Currency

 

 

 

 

 

The pricing request currency (e.g. GBP, USD, EUR). ISO 4217  

pricelist

priceList

Pricing List

 

 

 

 

reference 

Reference to the Pricing List  

shippingAddresses

postalAddress*

Pricing Shipping Addresses

 

 

 

 

child 

Postal (shipping) Address(es) associated with the document.  

carrierTradingAccount

tradingAccount

Carrier TradingAccount

 

 

 

 

reference 

Supplier Trading Account that will be the carrier / freight forwarder / deliverer of the document.  

carrierNetPrice

decimal

Carrier Net Price

 

 

 

 

 

The price of Delivery/carriage.  

carrierTaxPrice

decimal

Carrier Tax Price

 

 

 

 

 

The tax on Delivery/carriage.  

carrierGrossPrice

decimal

Carrier Gross Price

 

 

 

 

 

The total price of Delivery/carriage (net + tax).  

carrierReference

normalizedString

Carrier Reference Number

 

 

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

salesPersons

salesPerson*

SalesPersons

 

 

 

 

association 

Sales person on the associated document (Sales Order or Quotation)  

buyerContact

contact

Buyer Contact

 

 

 

 

reference 

Pricing Document Buyer Contact ID. ID of the contact who raised the associated purchase document (Purchase Order or Requisition).  

taxCodes

taxCode*

Tax Codes

 

 

 

 

association 

Pricing Tax Code ID. ID of the tax code governing the tax regime applicable to this pricing request.  

doNotChangePrice

boolean

Do Not Change Price

 

 

 

 

 

Pricing Do Not Change Price Flag. Flag to indicate if the pricing request should change the price. True means the user is requesting that the pricing request does not change the price. False means the user wants the pricing request to change the price if necessary. Default = False (price service can change Price).  

discountType

discountType

Discount Type

 

 

 

 

 

Pricing Document Discount Type. Flag to indicate the type of discount applicable to this document (percent or amount)  

discountAmount

decimal

Discount Amount

 

 

 

 

 

Pricing Document Discount Amount. Discount applicable to this document expressed as an amount.  

discountPercent

decimal

Discount Percent

 

 

 

 

 

Pricing Document Discount Percent. Discount applicable to this document expressed as a percent.  

settlementDiscountType

discountType

Settlement Discount Type

 

 

 

 

 

Pricing Settlement Discount Type. Flag to indicate the type of settlement discount applicable to the Trading Account (percent or amount)  

settlementDiscountAmount

decimal

Settlement Discount Amount

 

 

 

 

 

Settlement Discount Amount. Discount applicable to this document expressed as an amount.  

settlementDiscountPercent

decimal

Settlement Discount Percent

 

 

 

 

 

Pricing Settlement Discount Percent. Settlement discount applicable to the Trading Account expressed as a percent.  

additionalDiscount1Type

discountType

Order Additional Discount1 Type

 

 

 

 

 

Flag to indicate the type of additional discount 1 applicable to this Pricing Document (percent or amount)  

additionalDiscount1Amount

decimal

Order Additional Discount1 Amount

 

 

 

 

 

Additional discount 1 applicable to the Pricing Document expressed as an amount.  

additionalDiscount1Percent

decimal

Order Additional Discount1 Percent

 

 

 

 

 

Additional discount 1 applicable to the Pricing Document expressed as a percent.  

additionalDiscount2Type

discountType

Order Additional Discount2 Type

 

 

 

 

 

Flag to indicate the type of additional discount 2 applicable to this Pricing Document (percent or amount)  

additionalDiscount2Amount

decimal

Order Additional Discount2 Amount

 

 

 

 

 

Additional discount 2 applicable to the Pricing Document expressed as an amount.  

additionalDiscount2Percent

decimal

Order Additional Discount2 Percent

 

 

 

 

 

Additional discount 2 applicable to the Pricing Document expressed as a percent.  

netTotal

decimal

Net Total

 

 

 

 

 

Total value of the associated document, including discounts, excluding tax.  

discountTotal

decimal

Discount Total

 

 

 

 

 

Pricing Document Discount Total. Total value of discounts applied to the associated document (all lines).  

taxTotal

decimal

Tax Total

 

 

 

 

 

Total tax applicable to the associated document (all lines).  

grossTotal

decimal

Gross Total

 

 

 

 

 

Gross Total. Total value of the associated document (all lines) including tax and discounts and charges.  

costTotal

decimal

Cost Total

 

 

 

 

 

Cost Total. Total cost of the Document.  

profitTotal

decimal

Profit Total

 

 

 

 

 

Profit Total. Total profit on the Document(e.g. net total - cost total).  

additionalText

string

Additional Text

 

 

 

 

 

Additional text returned by the pricing request. This is intended to be a short message for display on the same screen as the document. This could display for example textual information on the discount applied.  

pricingDocumentLines

pricingDocumentLine*

Pricing Lines

 

 

 

 

child 

Lines associated with this pricing request.  

Top  

Resource computePriceResponse

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

tradingAccount

tradingAccount

Trading Account

 

 

 

 

reference 

Link to the Trading Account (if any) associated with this pricing request.  

originatorDocument

computePriceOriginatorDocument--choice

Originator Document

 

 

 

 

reference 

Link to the document (if any) associated with this pricing request.  

date

dateTime

PricingDocumentDate

 

 

 

 

 

The date the document associated with this pricing request was opened.  

status

normalizedString

Pricing Document Status

 

 

 

 

 

Status of the document associated with this pricing request.  

currency

normalizedString

Pricing Document Currency

 

 

 

 

 

The pricing request currency (e.g. GBP, USD, EUR). ISO 4217  

pricelist

priceList

Pricing List

 

 

 

 

reference 

Reference to the Pricing List  

shippingAddresses

postalAddress*

Pricing Shipping Addresses

 

 

 

 

child 

Postal (shipping) Address(es) associated with the document.  

carrierTradingAccount

tradingAccount

Carrier TradingAccount

 

 

 

 

reference 

Supplier Trading Account that will be the carrier / freight forwarder / deliverer of the document.  

carrierNetPrice

decimal

Carrier Net Price

 

 

 

 

 

The price of Delivery/carriage.  

carrierTaxPrice

decimal

Carrier Tax Price

 

 

 

 

 

The tax on Delivery/carriage.  

carrierGrossPrice

decimal

Carrier Gross Price

 

 

 

 

 

The total price of Delivery/carriage (net + tax).  

carrierReference

normalizedString

Carrier Reference Number

 

 

 

 

 

Reference number as used by the carrier during Delivery, e.g. for Delivery tracking.  

salesPersons

salesPerson*

SalesPersons

 

 

 

 

association 

Sales person on the associated document (Sales Order or Quotation)  

buyerContact

contact

Buyer Contact

 

 

 

 

reference 

Pricing Document Buyer Contact ID. ID of the contact who raised the associated purchase document (Purchase Order or Requisition).  

taxCodes

taxCode*

Tax Codes

 

 

 

 

association 

Pricing Tax Code ID. ID of the tax code governing the tax regime applicable to this pricing request.  

doNotChangePrice

boolean

Do Not Change Price

 

 

 

 

 

Pricing Do Not Change Price Flag. Flag to indicate if the pricing request should change the price. True means the user is requesting that the pricing request does not change the price. False means the user wants the pricing request to change the price if necessary. Default = False (price service can change Price).  

discountType

discountType

Discount Type

 

 

 

 

 

Pricing Document Discount Type. Flag to indicate the type of discount applicable to this document (percent or amount)  

discountAmount

decimal

Discount Amount

 

 

 

 

 

Pricing Document Discount Amount. Discount applicable to this document expressed as an amount.  

discountPercent

decimal

Discount Percent

 

 

 

 

 

Pricing Document Discount Percent. Discount applicable to this document expressed as a percent.  

settlementDiscountType

discountType

Settlement Discount Type

 

 

 

 

 

Pricing Settlement Discount Type. Flag to indicate the type of settlement discount applicable to the Trading Account (percent or amount)  

settlementDiscountPercent

decimal

Settlement Discount Percent

 

 

 

 

 

Pricing Settlement Discount Percent. Settlement discount applicable to the Trading Account expressed as a percent.  

additionalDiscount1Type

discountType

Order Additional Discount1 Type

 

 

 

 

 

Flag to indicate the type of additional discount 1 applicable to this Pricing Document (percent or amount)  

additionalDiscount1Amount

decimal

Order Additional Discount1 Amount

 

 

 

 

 

Additional discount 1 applicable to the Pricing Document expressed as an amount.  

additionalDiscount1Percent

decimal

Order Additional Discount1 Percent

 

 

 

 

 

Additional discount 1 applicable to the Pricing Document expressed as a percent.  

additionalDiscount2Type

discountType

Order Additional Discount2 Type

 

 

 

 

 

Flag to indicate the type of additional discount 2 applicable to this Pricing Document (percent or amount)  

additionalDiscount2Amount

decimal

Order Additional Discount2 Amount

 

 

 

 

 

Additional discount 2 applicable to the Pricing Document expressed as an amount.  

additionalDiscount2Percent

decimal

Order Additional Discount2 Percent

 

 

 

 

 

Additional discount 2 applicable to the Pricing Document expressed as a percent.  

netTotal

decimal

Net Total

 

 

 

 

 

Total value of the associated document, including discounts, excluding tax.  

discountTotal

decimal

Discount Total

 

 

 

 

 

Pricing Document Discount Total. Total value of discounts applied to the associated document (all lines).  

taxTotal

decimal

Tax Total

 

 

 

 

 

Total tax applicable to the associated document (all lines).  

grossTotal

decimal

Gross Total

 

 

 

 

 

Gross Total. Total value of the associated document (all lines) including tax and discounts and charges.  

costTotal

decimal

Cost Total

 

 

 

 

 

Cost Total. Total cost of the Document.  

profitTotal

decimal

Profit Total

 

 

 

 

 

Profit Total. Total profit on the Document(e.g. net total - cost total).  

additionalText

string

Additional Text

 

 

 

 

 

Additional text returned by the pricing request. This is intended to be a short message for display on the same screen as the document. This could display for example textual information on the discount applied.  

pricingDocumentLines

pricingDocumentLine*

Pricing Lines

 

 

 

 

child 

Lines associated with this pricing request.  

Top  

Resource pricingDocumentLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

commodity

commodity

Commodity

 

 

 

 

reference 

Commodity ID. The unique identifier of the Commodity used on the associated document Line.  

commodityVariant

commodityVariant

Commodity Variant

 

 

 

 

reference 

Commodity Variant ID. The Variant of the Commodity (e.g. colour or size) on the Sales Order Line.  

commodityDimension

commodityDimension

Commodity Dimension

 

 

 

 

reference 

Commodity Dimension ID. The Dimension of the Commodity on the Sales Order Line.  

quantity

decimal

Quantity

 

 

 

 

 

Quantity. The quantity of the Commodity ordered on the associated document Line.  

unitOfMeasure

unitOfMeasure

Unit of Measure

 

 

 

 

reference 

The unique identifier of the Unit of Measure for the Commodity on the associated document Line.  

lineType

lineType

Document Line Type

 

 

 

 

 

Pricing Document Line Type. Enumerator indicating the type of Line on the associated document. Allowable values: Standard Line; Free Text (with price); Commentary (without price, e.g. thank you for your business!); Component (with price but not in total); Discount/Charge (included price/total)  

fulfillmentLocation

location

Fulfillment Location

 

 

 

 

reference 

Fulfilment Location ID. The Location to/from which the document Line will be fulfilled (e.g. the warehouse receiving/holding the Commodity).  

description

normalizedString

Description

 

 

 

 

 

Pricing Document Line Description. Textual description of the associated document Line (e.g. the Commodity description, free text or commentary).  

enteredPrice

decimal

Entered Price

 

 

 

 

 

Pricing Document Line Entered Price. The entered price of the Commodity on the document Line (e.g. the requested price).  

initialPrice

decimal

Initial Price

 

 

 

 

 

Pricing Document Line Initial Price. The initial price of the Commodity on the document Line (e.g. list price, before discounts).  

actualPrice

decimal

Actual Price

 

 

 

 

 

Pricing Document Line Actual Price. The actual price of the Commodity on the document Line (e.g. after discounts or adjustments).  

doNotChangePrice

boolean

Do Not Change Price

 

 

 

 

 

Pricing Document Line Do Not Change Price Flag. Flag to indicate if the pricing request should change the price. True means the user is requesting that the pricing request does not change the price. False means the user wants the pricing request to change the price if necessary. Default = False (price service can change Price).  

discountType

discountType

Discount Type

 

 

 

 

 

Pricing Document Line Discount Type. Flag to indicate the type of discount applicable to this Document Line (percent or amount)  

discountAmount

decimal

Discount Amount

 

 

 

 

 

Pricing Document Line Discount Amount. Discount applicable to the document Line price, e.g. the per unit discount.  

discountPercent

decimal

Discount Percent

 

 

 

 

 

Pricing Document Line Discount Percent. Discount percent applicable to the document Line, e.g. the per unit discount percent.  

subtotalDiscountType

discountType

Subtotal Discount Type

 

 

 

 

 

Pricing Document Line Subtotal Discount Type. Flag to indicate the type of discount applicable to a subtotal of Pricing Document lines (percent or amount) of which this Line is part.  

subtotalDiscountAmount

decimal

Subtotal Discount Amount

 

 

 

 

 

Pricing Document Line Subtotal Discount Amount. Discount applicable to the Pricing Document Line, expressed as an amount.  

subtotalDiscountPercent

decimal

Subtotal Discount Percent

 

 

 

 

 

Pricing Document Line Subtotal Discount Percent. Discount applicable to the Pricing Document Line, expressed as a percentage.  

netTotal

decimal

Net Total

 

 

 

 

 

Pricing Document Line Net Total. Total value of the document Line, including discounts, excluding tax (e.g. quantity * actual price)  

chargesTotal

decimal

Charges Total

 

 

 

 

 

Pricing Document Line Charges Total. Total value of any (sur)charges applied to the associated document.  

discountTotal

decimal

Discount Total

 

 

 

 

 

Pricing Document Line Discount Total. Total value of all discount applied to the document Line (e.g. quantity x Line discount amount).  

taxCodes

taxCode*

Tax Codes

 

 

 

 

association 

Pricing Line Tax Code ID. ID of the tax code governing the tax regime applicable to this pricing request line.  

priceTax

decimal

Price Tax

 

 

 

 

 

Pricing Document Line Price Tax. Tax applicable to the document Line price, e.g. the per unit tax.  

taxTotal

decimal

Tax Total

 

 

 

 

 

Pricing Document Line Tax Total. Tax applicable to the document Line.  

grossTotal

decimal

Gross Total

 

 

 

 

 

Pricing Document Line Gross Total. Total value of the document Line including tax & discounts & charges.  

costTotal

decimal

Cost Total

 

 

 

 

 

Line Cost Total. Total cost of the Pricing Document Line.  

profitTotal

decimal

Profit Total

 

 

 

 

 

Pricing Document Line Profit Total. Total profit on the Pricing Document Line (e.g. net total - cost total).  

reference

normalizedString

Reference

X

 

 

 

 

Pricing Reference. Any reference returned by the pricing request.  

reference2

normalizedString

Reference2

 

X

 

 

 

Pricing Reference 2. Any additional reference returned by the pricing request.  

number

decimal

Number

 

 

 

 

 

Pricing Document Line Number. The number of the line. For sequencing and ordering of lines.  

priceChangeStatus

priceChangeStatusType

Price Change Status

 

 

 

 

 

Pricing Price Change Status. If the pricing service changes the quoted price, the repricing status is used to signify if the price has gone up or down. No Change = No Change (default); Price Up = Price went up; Price Down = Price went down.  

shortText

normalizedString

Short Text

 

 

 

 

 

Pricing Text Short. Additional text returned by the pricing request. This is intended to be a short message for display on the same screen as the line item  

longText

string

Long Text

 

 

 

 

 

Pricing Text Large. Additional text returned by the pricing request supported by SLX only. This is intended for display in a pop up dialog in CRM, and may display tables and other formatted information. It is envisaged that the amount of information returned will be large and so it need to be displayed on a separate screen to the line item. Definition: The Additional Price Information field provides the following information to the CRM system: - Price Breaks: Price break information that alerts the order-taker whether additional quantities purchased would result in a lower price for the customer - Additional Discounts: the discounts that the customer could qualify for if specific changes were made to the order - Any other information related to price that the ERP system would like to report  

Top  

Resource organization

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Organization Active Flag

 

 

 

 

 

Flag to indicate if the Organization is an active Organization .    

operatingCompany

operatingCompany

Organization OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Organization.   See OperatingCompany definition Company where type = Operating Company.  

reference

normalizedString

Organization Reference

X

 

 

 

 

Reference for the Organization.    

reference2

normalizedString

Organization Reference2

 

X

 

 

 

Additional reference for the Organization.    

status

normalizedString

Organization Status

 

X

 

 

 

Status of the Organization.    

name

normalizedString

Organization Name

 

 

 

X

 

The Organization name e.g. Career Family, Research and Development, Sales    

type

normalizedString

Organization Type

 

 

 

 

 

The Organization type e.g. Job Family, Unit    

positions

position*

Organization Position

 

X

 

 

association 

Link to the Positions associated with the Organization.   See Position definition.  

levelNumber

decimal

Organization Level Number

 

 

 

X

 

The level associated with the Position within the Organization in numeric format e.g. 1-15 in the Sage UK Career Framework or Sorting Level of Organizational Units.    

levelText

normalizedString

Organization Level Text

 

X

 

 

 

The level associated with the Position within the Organization – in textual format.    

bandNumber

decimal

Organization Band Number

 

X

 

 

 

The band associated with the Position within the Organization in numeric format.    

bandText

normalizedString

Organization Band Text

 

X

 

 

 

The band associated with the Position within the Organization – in textual format e.g. A-D in the Sage UK Career Framework.    

associatedParentOrganization

organization

Organization Associated Parent Organization

 

X

 

 

parent 

Link to Parent Organization associated with this Organization e.g. into which an Employee would be promoted.   Organization are usually hierarchical to represent a career path.  

associatedChildOrganizations

organization*

Organization Associated Child Organization

 

X

 

 

child 

Link to Child Organization associated with this Organization e.g. from which an Employee has been promoted or could be demoted.   Organization are usually hierarchical to represent a career path.  

postalAddresses

postalAddress*

Organization PostalAddresses

 

X

 

 

child 

Link to the main Organization addresses   See PostalAddress definition.  

phones

phoneNumber*

Organization Phones

 

X

 

 

child 

Organization telephone numbers.   See PhoneNumber definition.  

defaultWorkplace

workplace

Organization Default Workplace

 

X

 

 

reference 

The default Workplace associated with the Organization.   See Workplace definition. .  

financialAccounts

financialAccount*

Organization FinancialAccount

 

X

 

 

association 

Financial e.g. cost centre account associated with the Organization.   See FinancialAccount definition.  

costCentres

costCentre*

Organization CostCentre

 

X

 

 

association 

 

departments

department*

Organization Department

 

X

 

 

association 

 

text1

string

Organization Text1

 

X

 

 

 

Textual information associated with the Organization.    

text2

string

Organization Text2

 

X

 

 

 

Textual information associated with the Organization.    

startDate

date

Organization Start Date

 

X

 

 

 

A start date associated with the Organization if applicable.    

endDate

date

Organization End Date

 

X

 

 

 

A start date associated with the Organization if applicable – e,g, to support restructuring of an Organization.    

notes

note*

Organization Note

 

X

 

 

child 

Notes associated with an Organization.    

Top  

Resource position

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Position Active Flag

 

 

 

 

 

Flag to indicate if the Position is an active Position.    

operatingCompany

operatingCompany

Position OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Position.   See OperatingCompany definition Company where type = Operating Company.  

department

normalizedString

Position Department

 

X

 

 

 

Department within the Operating Company the Position is for.    

organization

organization

Position Organization

 

X

 

 

reference 

Link to the Organization associated with this Position.   See Organization definition.  

reference

normalizedString

Position Reference

X

 

 

 

 

Reference for the Position e.g. JOB001.    

reference2

normalizedString

Position Reference2

 

X

 

 

 

Additional reference for the Position.    

status

positionStatus

Position Status

 

 

 

 

 

Status of the Position    

name

normalizedString

Position Name

 

 

 

X

 

The Position name typically the Job name, e.g. Product Development Manager    

shortName

normalizedString

Position Short Name

 

X

 

 

 

A shorter name for the Position e.g. PDM.    

type

positionType

Position Type

 

 

 

 

 

The Position type e.g. Permanent, Part-Time, etc.    

employment

employment

Position Employment

 

X

 

 

reference 

Employment contract associated with the Position. This may be prospective terms if the Position is Vacant, or actual terms if the Position is filled.   See Employment definition.  

workplace

workplace

Position Workplace

 

X

 

 

reference 

The Workplace associated with the Position.   See Workplace definition. .  

postalAddresses

postalAddress*

Position PostalAddresses

 

X

 

 

child 

Link to the current Position addresses   See PostalAddress definition.  

phones

phoneNumber*

Position Phones

 

X

 

 

child 

Position telephone numbers.   See PhoneNumber definition.  

emails

email*

Position Emails

 

X

 

 

child 

Position email addresses.   See Email definition.  

employees

employee*

Position Employee

 

X

 

 

association 

Link to the Employees associated with the Position if any – may be Vacant.   See Employee definition.  

managerEmployee

employee

Position Manager Employee

 

X

 

 

reference 

A link to managers Employee record.   See Employee definition.  

text1

string

Position Text1

 

X

 

 

 

Textual information associated with the Position.    

text2

string

Position Text2

 

X

 

 

 

Textual information associated with the Position.    

startedDate

date

Position Started Date

 

X

 

 

 

Date the Position was or is to be originated e.g. Secondment.    

endedDate

date

Position Ended Date

 

X

 

 

 

Date the Position was or is to be closed.    

competenciesRequired

competency*

Position Competencies Required

 

X

 

 

association 

A link to the Competencies required of the Position.   See Competency definition.  

primacyIndicator

boolean

Position Primacy Indicator

 

X

 

 

 

Flag to indicate if this Position is the primary one e.g. for the associated Employee.    

externalPositionFlag

boolean

Position External Position Flag

 

X

 

 

 

Flag to indicate if this position is held externally to the employing company e.g. where a record is being kept of voluntary, governmental, supplementary positions.   True = External position  

notes

note*

Position Note

 

X

 

 

child 

Notes associated with a Position.    

Top  

Resource vacancy

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Vacancy Active Flag

 

 

 

 

 

Flag to indicate if the Vacancy is an active Vacancy.    

operatingCompany

operatingCompany

Vacancy OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Vacancy.   See OperatingCompany definition Company where type = Operating Company.  

organization

organization

Vacancy Organization

 

X

 

 

reference 

Link to the Organization associated with this Vacancy.   See Organization definition.  

position

position

Vacancy Position

 

X

 

 

reference 

Link to the Position the Vacancy is for.   See Position definition.  

reference

normalizedString

Vacancy Reference

X

 

 

 

 

Reference for the Vacancy e.g. 000456.    

reference2

normalizedString

Vacancy Reference2

 

X

 

 

 

Additional reference for the Vacancy.    

status

vacancyStatus

Vacancy Status

 

 

 

 

 

Status of the Vacancy    

name

normalizedString

Vacancy Name

 

 

 

X

 

The Vacancy name typically the Job name, e.g. Product Development Manager    

shortName

normalizedString

Vacancy Short Name

 

X

 

 

 

A shorter name for the Vacancy e.g. PDM.    

type

vacancyType

Vacancy Type

 

 

 

 

 

The Vacancy type e.g. Permanent, Part-Time, etc.    

positionsAvailable

decimal

Vacancy Positions Available

 

X

 

X

 

A numeric value indicating the number of Vacancy Positions that are available.   Default = 1  

createdDate

date

Vacancy Created Date

 

X

 

 

 

Date the Vacancy was originated.    

targetStartDate

date

Vacancy Target Start Date

 

X

 

 

 

Target start date for the Vacancy i.e. when Employee expected to start Employment.    

applicationClosingDate

date

Vacancy Application Closing Date

 

X

 

 

 

Application closing date, after which no new Candidates will be accepted.    

applicationMethod

normalizedString

Vacancy Application Method

 

X

 

 

 

Value indicating the preferred application method for the Vacancy e.g. Web, Post, Email, Agency, etc.    

assessmentStartingDate

date

Vacancy Assessment Starting Date

 

X

 

 

 

Date when Candidates will be assessed e.g. when interviews, etc commence    

assessingEmployees

employee*

Vacancy Assessing Employee

 

X

 

 

association 

Details of the Employee doing the Candidate assessment. Could be many as this could be a recruiting panel.   See Employee definition.  

administratingEmployees

employee*

Vacancy Administrating Employee

 

X

 

 

association 

A link to the Employee who administers the Vacancy.   See Employee definition.  

closingDate

date

Vacancy Closing Date

 

X

 

 

 

Date the Vacancy is to be closed.    

workplace

workplace

Vacancy Workplace

 

X

 

 

reference 

The Workplace associated with the Vacancy.   See Workplace definition. .  

candidates

candidate*

Vacancy Candidate

 

X

 

 

association 

Candidates associated with the Vacancy.   See Employee definition.  

employees

employee*

Vacancy Employee

 

X

 

 

association 

Link to the Employees associated with the Vacancy if Vacancy status is Appointed.   See Employee definition.  

supplier

tradingAccount

Vacancy Supplier

 

X

 

 

reference 

A link to a Supplier e.g. if the whole Vacancy is outsourced to a recruitment agency.   See Supplier definition. CRM schema.  

text1

string

Vacancy Text1

 

X

 

 

 

Textual information associated with the Vacancy.    

text2

string

Vacancy Text2

 

X

 

 

 

Textual information associated with the Vacancy.    

competenciesRequired

competency*

Vacancy Competencies Required

 

X

 

 

association 

A link to the Competencies required in order to be suitable for the Vacancy.   See Competency definition.  

notes

note*

Vacancy Note

 

X

 

 

child 

Notes associated with a Vacancy.    

Top  

Resource employee

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

employeeGroups

employeeGroup*

Employee EmployeeGroups

 

 

 

 

association 

A link to the Employee Groups associated with this Employee.   See EmployeeGroup definition. Employees can belong to multiple Employee Groups.  

active

boolean

Employee Active Flag

 

 

 

 

 

Flag to indicate if the Employee is an active Employee .    

reference

normalizedString

Employee Reference

X

 

 

 

 

Reference for the Employee e.g. Employee/Payroll number.    

reference2

normalizedString

Employee Reference2

 

X

 

 

 

Additional reference for the Employee.    

status

normalizedString

Employee Status

 

X

 

 

 

Status of the Employee.    

type

normalizedString

Employee Type

 

X

 

 

 

The Employee type e.g. Full Time, Part Time, etc.   Could be derived from Employment.  

gender

employeeGender

Employee Gender

 

 

 

X

 

The gender of the Employee e.g. Male, Female, Not Specified.    

fullName

normalizedString

Employee Full Name

 

 

 

X

 

The full name of the Employee e.g. title, first name, family name, suitably spaced.   Formatted name for display purposes.  

salutation

normalizedString

Employee Salutation

 

X

 

 

 

The salutation to be used when addressing the Employee Dear, Your Excellency, etc.    

firstName

normalizedString

Employee First Name

 

X

 

 

 

The first name of the Employee.    

preferredName

normalizedString

Employee Preferred Name

 

X

 

 

 

The name preferred by the Employee – may be first name or a nick name.   Could use First Name as default  

familyName

normalizedString

Employee Family Name

 

X

 

 

 

The family name surname of the Employee.    

previousFamilyName

normalizedString

Employee Previous Family name

 

X

 

 

 

Any previous family name used by the Employee before marriage.    

title

normalizedString

Employee Title

 

X

 

 

 

The title of the Employee.   Language-specific  

middleName

normalizedString

Employee Middle Name

 

X

 

 

 

The middle name of the Employee.    

suffix

normalizedString

Employee Suffix

 

X

 

 

 

A name suffix associated with the Employee e.g. PhD, OBE, etc    

financialAccounts

financialAccount*

Employee FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Employee typically the wages/salary account.   See FinancialAccount definition.  

costCentres

costCentre*

Employee CostCentre

 

X

 

 

association 

 

departments

department*

Employee Department

 

X

 

 

association 

 

resumes

resume*

Employee Resume

 

X

 

 

association 

Link to the Employees Resumes   See Resume definition.  

age

decimal

Employee Age

 

X

 

 

 

The age of the Employee.   Could be calculated from date of birth.  

dateOfBirth

date

Employee Date Of Birth

 

X

 

 

 

The date of birth of the Employee.    

cityOfBirth

normalizedString

Employee City of Birth

 

X

 

 

 

The city of birth of the Employee    

countryOfBirth

normalizedString

Employee Country of Birth

 

X

 

 

 

The country of birth of the Employee   ISO 3166-1 alpha-2 country codes only  

nationality

normalizedString

Employee Nationality

 

X

 

 

 

The nationality of the Employee.    

language

normalizedString

Employee Language

 

X

 

 

 

Language used spoken by the Employee e.g. EN-GB.   ISO 639  

maritalStatus

normalizedString

Employee Marital Status

 

X

 

 

 

The marital status single, married, etc of the Employee.    

countryOfResidence

normalizedString

Employee Country of Residence

 

X

 

 

 

The country of residence of the Employee.   ISO 3166-1 alpha-2 country codes only  

ethnicOrigin

normalizedString

Employee Ethnic Origin

 

X

 

 

 

The ethnic origin of the Employee.    

faith

normalizedString

Employee Faith

 

X

 

 

 

The faith of the Employee.    

disabilityFlag

boolean

Employee Disability Flag

 

X

 

 

 

A flag to indicate if the Employee is registered disabled.    

disabilityValue

decimal

Employee Disability Value

 

X

 

 

 

A numeric value associated with the Employee disability if applicable.    

disabilityText

normalizedString

Employee Disability Text

 

X

 

 

 

A text value associated with the Employee disability if applicable.    

disabilityStartDate

date

Employee Disability Start Date

 

X

 

 

 

A start date associated with the Employee disability if applicable.    

disabilityEndDate

date

Employee Disability End Date

 

X

 

 

 

An end date associated with the Employee disability if applicable.    

nationalInsuranceNumber

normalizedString

Employee National Insurance Number

 

X

 

 

 

The national insurance, or country-specific equivalent, number, e.g. numero de securite sociale.    

taxReference

normalizedString

Employee Tax Reference

 

X

 

 

 

Reference number for tax purposes of the Employee e.g. UK UTR.    

taxCodes

taxCode*

Employee Tax Code

 

X

 

 

association 

Code used for the calculation of taxes for the Employee.   In the UK this is known as the Tax Code.  

taxClass

employeeTaxClass

Employee Tax Class

 

X

 

 

 

Code defining the Tax Class of the Employee.   0 - Cumulative 1 – Week/1 Used in tax calculations.  

collectiveAgreementCode

normalizedString

Employee Collective Agreement Code

 

X

 

 

 

Code referring to the collective e.g. union, minimum wage agreement in place for the employee.    

postalAddresses

postalAddress*

Employee PostalAddresses

 

X

 

 

child 

Link to the Employee addresses e.g. home address.   See PostalAddress definition.  

phones

phoneNumber*

Employee Phones

 

X

 

 

child 

Employee telephone numbers.   See PhoneNumber definition.  

emails

email*

Employee Emails

 

X

 

 

child 

Employee email addresses.   See Email definition.  

website

normalizedString

Employee Web site

 

X

 

 

 

Employee web site address.    

operatingCompany

operatingCompany

Employee OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Employee.   See OperatingCompany definition Company where type = Operating Company.  

bankAccounts

bankAccount*

Employee Bank Account

 

X

 

 

association 

Link to the Bank Account if any associated with this Employee.   See BankAccount definition.  

employments

employment*

Employee Employment

 

X

 

 

association 

Employment contract associated with the Employee. May be many as Employee may have progressed through many different Employments with the same Company.   See Employment definition.  

workplaces

workplace*

Employee Workplace

 

X

 

 

association 

Link to the Location if any associated with this Employee.   See Workplace definition.  

competencies

competency*

Employee Competency

 

X

 

 

association 

A link to the Competencies shown by the Employee   See Competency definition.  

multiplePositionIndicator

boolean

Employee Multiple Position Indicator

 

X

 

 

 

A flag to indicate if the Employee holds more than one Position within the Operating Company.   Default = False  

positions

position*

Employee Position

 

X

 

 

association 

Position currently occupied by the Employee.   See Position definition. Link is 1:1 if Multiple Position Indicator = False  

managerEmployee

employee

Employee Manager Employee

 

X

 

 

reference 

A link to managers Employee record.   See Employee definition.  

authoriserEmployees

employee*

Employee Authorisers

 

X

 

 

association 

A link to other Employees who may authorise transactions for this Employee.   See Employee definition.  

retirementCategory

normalizedString

Employee Retirement Category

 

X

 

 

 

A flag indicating the type of retirement category this employee falls/will fall in.    

statutoryRetirementDate

date

Employee Statutory Retirement Date

 

X

 

 

 

The statutory date of retirement as governed by applicable laws.    

electiveRetirementDate

date

Employee Elective Retirement Date

 

X

 

 

 

Date elected by the Employee for retirement.    

compulsoryRetirementDate

date

Employee Compulsory Retirement Date

 

X

 

 

 

The compulsory date of retirement as defined by the Employer.    

leavingDate

date

Employee Leaving Date

 

X

 

 

 

Date the employee left the Employee of a particular Company    

lastWorkingDay

date

Employee Last Working Day

 

X

 

 

 

Date of the last working day of the Employee before leaving.    

leaveReason

normalizedString

Employee Leave Reason

 

X

 

 

 

Textual reason information as to why Employee has left.    

noticePeriod

decimal

Employee Notice Period

 

X

 

 

 

Period of notice expected from an Employee when leaving.   In Employee Notice Unit  

noticeUnit

employeeNoticeUnit

Employee Notice Unit

 

X

 

 

 

Time unit of measure applicable to the Employees notice period typically weeks or months.    

employerNoticePeriod

decimal

Employee Employer Notice Period

 

X

 

 

 

Period of notice expected from an Employer when dismissing an Employee.   In Employer Notice Unit  

employerNoticeUnit

employeeEmployerNoticeUnit

Employee Employer Notice Unit

 

X

 

 

 

Time unit of measure applicable to the Employers notice period typically weeks or months.    

noticeGivenBy

employeeNoticeGivenBy

Employee Notice Given By

 

X

 

 

 

Flag indicating who is giving notice of leaving – Employee or Employer.    

noticeGivenDate

date

Employee Notice Given Date

 

X

 

 

 

Date notice was given.    

noticeType

normalizedString

Employee Notice Type

 

X

 

 

 

The type of notice given by the Employee. This could be something decided by the Employee, the Employer, or through mutual agreement.    

probationPeriod

normalizedString

Employee Probation Period

 

X

 

 

 

Period of probation given to an Employee typically applies to new Employees.    

probationUnit

employeeProbationUnit

Employee Probation Unit

 

X

 

 

 

Time unit of measure applicable to the Employees probation period typically weeks or months.    

probationEndDate

date

Employee Probation End Date

 

X

 

 

 

Date a period of probation will expire or require review if applicable.    

probationRenewed

boolean

Employee Probation Renewed Flag

 

X

 

 

 

Flag to indicate if probation has been renewed.    

continuousEmploymentDate

date

Employee Continuous Employment Date

 

X

 

 

 

Date when continuous employment commenced Seniority.    

passportNumber

normalizedString

Employee Passport Number

 

X

 

 

 

The passport number of the Employee    

passportIssuer

normalizedString

Employee Passport Issuer

 

X

 

 

 

The authority issuing the Passport e.g. UK PA.    

residencePermitNumber

normalizedString

Employee Residence Permit Number

 

X

 

 

 

The number of any Residence permit used by the Employee.    

residencePermitStartDate

date

Employee Residence Permit Start Date

 

X

 

 

 

The date the Employee Residence permit starts.    

residencePermitEndDate

date

Employee Residence Permit End Date

 

X

 

 

 

The date the Employee Residence permit ends.    

residencePermitIssuer

normalizedString

Employee Residence Permit Issuer

 

X

 

 

 

The authority issuing the Residence permit.    

workPermitNumber

normalizedString

Employee Work Permit Number

 

X

 

 

 

The number of any work permit used by the Employee.    

workPermitStartDate

date

Employee Work Permit Start Date

 

X

 

 

 

The date the Employee work permit starts.    

workPermitEndDate

date

Employee Work Permit End Date

 

X

 

 

 

The date the Employee work permit ends.    

workPermitIssuer

normalizedString

Employee Work Permit Issuer

 

X

 

 

 

The authority issuing the work permit.    

drivingLicenseNumber

normalizedString

Employee Driving License Number

 

X

 

 

 

The number of any Driving License used by the Employee.    

drivingLicenseStartDate

date

Employee Driving License Start Date

 

X

 

 

 

The date the Employee Driving License starts.    

drivingLicenseEndDate

date

Employee Driving License End Date

 

X

 

 

 

The date the Employee Driving License ends.    

drivingLicenseIssuer

normalizedString

Employee Driving License Issuer

 

X

 

 

 

The authority issuing the Driving License.    

drivingLicenseCategory

normalizedString

Employee Driving License Category

 

X

 

 

 

The category of the Driving License e.g. car, PLG, HGV, motorcycle, etc.    

drivingLicenseSuspended

boolean

Employee Driving License Suspended

 

X

 

 

 

A flag to indicate if the Driving License is suspended Driving ban.   Default = False  

emergencyContacts

relatedParty*

Employee Emergency Contact

 

X

 

 

association 

Emergency contact details for the Employee in case of accident/illness   See Related Party definition.  

formerEmployee

employee

Employee Former Employee

 

X

 

 

reference 

A link to the former Employee record for the Employee, if the Employee has been Employed by the Operating Company before.   See Employee definition.  

workingTimeOptOutFlag

boolean

Employee Working Time Reg Opt Out Flag

 

X

 

 

 

Flag to indicate if the Employee has opted out of pertinent working time regulations typically maximum work time allowed.   Default = False  

supplier

tradingAccount

Employee Supplier

 

X

 

 

reference 

A link to a Supplier used to find the Employee e.g. if the Employee was sourced from a recruitment agency.   See Supplier definition. CRM schema.  

timesheets

timesheet*

Employee Timesheet

 

X

 

 

association 

Timesheets associated with the Employee.   See Timesheet definition.  

expenseClaims

expenseClaim*

Employee Expense Claim

 

X

 

 

association 

Expense Claims associated with the Employee.   See ExpenseClaim definition.  

payrolls

payroll*

Employee Payroll

 

X

 

 

association 

Payrolls associated with the Employee.   See Payroll definition.  

payslips

payslip*

Employee Payslip

 

X

 

 

association 

Payslips associated with the Employee.   See Payslip definition.  

payments

payment*

Employee Payment

 

X

 

 

association 

Payments associated with the Employee.   See Payment definition.  

projects

project*

Employee Project

 

X

 

 

association 

Projects associated with the Employee.   See Project definition.  

objectives

objective*

Employee Objective

 

X

 

 

association 

Link to Objectives associated with this Employee.   See Objective definition.  

appraisals

appraisal*

Employee Appraisal

 

X

 

 

association 

Link to the Employees Appraisals.   See Appraisal definition.  

trainingEvents

trainingEvent*

Employee Training Event Attended

 

X

 

 

association 

Link to attendance on Training Events.   See Training Event definition.  

rates

rate*

Employee Rate

 

X

 

 

association 

Rates associated with the Employee e.g. Cost, Charge, Pay   See Rate definition.  

dependents

relatedParty*

Employee Dependent

 

X

 

 

association 

Link to any dependents of the Employee.   See Related Party definition  

beneficiaries

relatedParty*

Employee Beneficiary

 

X

 

 

association 

Link to any Beneficiaries of the Employee Beneficiaries may or may not be dependents.   See Related Party definition  

incidents

incident*

Employee Incident

 

X

 

 

association 

Link to any Incidents association with the Employee.   See Incident definition.  

disciplinaries

disciplinary*

Employee Disciplinary

 

X

 

 

association 

Link to any Disciplinaries association with the Employee.   See Disciplinary definition.  

isSmokerFlag

boolean

Employee Is Smoker Flag

 

X

 

 

 

Flag to indicate if Employee is a smoker.   Default = False  

rehireFlag

boolean

Employee Rehire Flag

 

X

 

 

 

Flag to indicate if the Employee should be re-hired/re-employed True means they can be re-hired   Default = True  

futurePositions

position*

Employee Future Position

 

X

 

 

association 

A link to one or more Positions that may, in the future, be occupied by the Employee. Used for succession planning.   See Position definition.  

person

person

Employee Person

 

X

 

 

reference 

A link to the Person associated with this Employee.   See person definition. persons are defined in the common Schema.  

notes

note*

Employee Note

 

X

 

 

child 

Notes associated with an Employee.    

user

normalizedString

Employee User

 

X

 

 

 

Default system user associated with this Employee.  

Top  

Resource employeeGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

EmployeeGroup Active Flag

 

 

 

 

 

Flag to indicate if the Employee Group is an active one .    

reference

normalizedString

EmployeeGroup Reference

X

 

 

 

 

Reference for the Employee Group.    

reference2

normalizedString

EmployeeGroup Reference2

 

X

 

 

 

Additional reference for the Employee Group.    

name

normalizedString

EmployeeGroup Name

 

 

 

X

 

Name of the Employee Group.   If this does not exist then a dummy entry should be created, e.g. MAS500 Employees  

description

normalizedString

EmployeeGroup Description

 

X

 

 

 

A longer description of the Employee Group.    

associatedEmployeeGroups

employeeGroup*

EmployeeGroup Associated EmployeeGroups

 

X

 

 

association 

A link to other Employee Groups associated with this one.    

employees

employee*

EmployeeGroup Employee

 

X

 

 

association 

Employees associated with the Employee Group.   See Employee definition. Employees can belong to multiple Employee Groups.  

notes

note*

EmployeeGroup Note

 

X

 

 

child 

Notes associated with an Employee Group.    

Top  

Resource employment

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Employment Active Flag

 

 

 

 

 

Flag to indicate if the Employment is an active Employment.    

operatingCompany

operatingCompany

Employment OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Employment.   See OperatingCompany definition Company where type = Operating Company.  

positions

position*

Employment Position

 

X

 

 

association 

Link to the Position associated with this Employment.   See Organization definition.  

employees

employee*

Employment Employee

 

X

 

 

association 

Link to the Employee associated with the Employment.   See Employee definition.  

reference

normalizedString

Employment Reference

X

 

 

 

 

Reference for the Employment e.g. 000456.    

reference2

normalizedString

Employment Reference2

 

X

 

 

 

Additional reference for the Employment.    

status

employmentStatus

Employment Status

 

 

 

 

 

Status of the Employment    

name

normalizedString

Employment Name

 

 

 

X

 

The Employment name e.g. terms and conditions    

type

employmentType

Employment Type

 

 

 

X

 

The Employment type e.g. Permanent, Part-Time, etc.    

contractType

normalizedString

Employment Contract Type

 

X

 

 

 

Type of the Employment contract given to an Employee e.g. Casual, Home worker, Contractor, etc or nature of contract in France e.g. CDD, CDI, etc    

workType

employmentWorkType

Employment Work Type

 

X

 

 

 

The type of work    

contractCategory

normalizedString

Employment Contract Category

 

X

 

 

 

The legal category of the contract, as agreed with the relevant authorities e.g. cadre in France.    

contractSubCategory

normalizedString

Employment Contract Sub-Category

 

X

 

 

 

The legal sub category of the contract, as agreed with the relevant authorities e.g. cadre in France.    

acceptedDate

date

Employment Accepted Date

 

X

 

 

 

The date the Employment offer was accepted.    

reason

normalizedString

Employment Reason

 

X

 

 

 

Reason for Employment, e.g., New Hire, Secondment, Maternity Cover.    

justification

normalizedString

Employment Justification

 

X

 

 

 

For some types of Employment contract it may be necessary to justify the type of contract e.g. if contract type = CDD in France, then this will be mandatory.    

duration

decimal

Employment Duration

 

X

 

 

 

The duration of the contract, as expressed in duration units e.g. 6 months.    

durationUnit

employmentDurationUnit

Employment Duration Unit

 

X

 

 

 

The unit of duration associated with the Employment contract e.g. months.    

startedDate

date

Employment Started Date

 

X

 

 

 

Date the Employment was originated.    

noticePeriod

decimal

Employment Notice Period

 

X

 

 

 

Period of notice expected when terminating the Employment contract.   In Employment Notice Unit  

noticeUnit

employmentNoticeUnit

Employment Notice Unit

 

X

 

 

 

Time unit of measure applicable to the Employments notice period typically weeks or months.    

employerNoticePeriod

decimal

Employment Employer Notice Period

 

X

 

 

 

Period of notice expected from an Employer when terminating the Employment contract.   In Employer Notice Unit  

employerNoticeUnit

employmentEmployerNoticeUnit

Employment Employer Notice Unit

 

X

 

 

 

Time unit of measure applicable to the Employers notice period typically weeks or months.    

noticeGivenBy

employmentNoticeGivenBy

Employment Notice Given By

 

X

 

 

 

Flag indicating who is giving notice of leaving – Employee or Employer.    

noticeGivenDate

date

Employment Notice Given Date

 

X

 

 

 

Date notice was given.    

noticeType

normalizedString

Employment Notice Type

 

X

 

 

 

The type of notice given by the Employment. This could be something decided by the Employment, the Employer, or through mutual agreement.    

probationPeriod

normalizedString

Employment Probation Period

 

X

 

 

 

Period of probation given to an Employee when taking the Employment contract typically applies to new Employments.    

probationUnit

employmentProbationUnit

Employment Probation Unit

 

X

 

 

 

Time unit of measure applicable to the Employments probation period typically weeks or months.    

probationEndDate

date

Employment Probation End Date

 

X

 

 

 

Date a period of probation will expire or require review if applicable.    

probationRenewed

boolean

Employment Probation Renewed Flag

 

X

 

 

 

Flag to indicate if probation has been renewed.    

endedDate

date

Employment Ended Date

 

X

 

 

 

Date the Employment is to be closed.    

endedReason

normalizedString

Employment Ended Reason

 

X

 

 

 

Reason for Employment termination e.g. Resignation, Dismissal, End of Contract. This is different from the Employee Leave Reason on the Employee record as a particular instance of Employment may end but another one for the same Employee may commence.    

endedFlag

boolean

Employment Ended Flag

 

X

 

 

 

Flag to indicate if the Employment has in fact ended.   Default = False  

workplaces

workplace*

Employment Workplace

 

X

 

 

association 

The Workplace associated with the Employment.   See Workplace definition. .  

phones

phoneNumber*

Employment Phones

 

X

 

 

child 

Employment telephone numbers e.g. office, works mobile, etc   See PhoneNumber definition.  

emails

email*

Employment Emails

 

X

 

 

child 

Employment email addresses e.g. work email.   See Email definition.  

jobTitle

normalizedString

Employment Job Title

 

X

 

 

 

Job Title associated with the Employment.    

jobType

employmentJobType

Employment Job Type

 

X

 

 

 

Job type relevant to the Job Title e.g. Manager, Supervisor, etc    

jobQualificationLevel

normalizedString

Employment Job Qualification Level

 

X

 

 

 

Job qualification level relevant to the job e.g. manual, skilled, technical, etc.    

hazardousIndicator

boolean

Employment Hazardous Indicator

 

X

 

 

 

Flag to indicate if the Employment is hazardous e.g. working in radioactive, dangerous situations.   Default = False  

hazardousText

normalizedString

Employment Hazardous text

 

X

 

 

 

If the Employment is hazardous then this allows for a description of the hazard.    

text1

string

Employment Text1

 

X

 

 

 

Textual information associated with the Employment.    

text2

string

Employment Text2

 

X

 

 

 

Textual information associated with the Employment.    

workTimes

workTime*

Employment Work Times

 

X

 

 

association 

Working times applicable to the Employment.   See WorkTime definition.  

benefits

benefit*

Employment Benefit

 

X

 

 

association 

Benefits applicable to the Employment.   See Benefit definition.  

payrollType

employmentPayrollType

Employment Payroll Type

 

X

 

 

 

The type of payroll that will be used/associated with the Employment contract.    

payrollPaymentMethod

employmentPayrollPaymentMethod

Employment Payroll Payment Method

 

 

 

 

 

The payment method used in Payrolls associated with this Employment.    

payrollPayFrequency

employmentPayrollPayFrequency

Employment Payroll Pay Frequency

 

 

 

 

 

Frequency with which payments are made in association with this Employment there will usually be one Payroll entry per pay frequency.    

payrollTaxCodes

taxCode*

Employment Payroll Tax Code

 

X

 

 

association 

Code used during the calculation of taxes for the Payrolls associated with this Employment.   May be derived from Employee  

payrollCurrency

normalizedString

Employment Payroll Currency

 

 

 

 

 

Currency of the Payrolls associated with this Employment.   ISO 4217.  

operatingCompanyCurrency

normalizedString

Employment OperatingCompany Currency

 

X

 

 

 

The currency as used by the Operating Company, the business operating the Sage application the base currency.   ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Employment OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Employment Payroll Currency into Employment Operating Company Currency, if different.   Default = 1  

operatingCompanyCurrencyExchangeRateOperator

employmentOperatingCompanyCurrencyExchangeRateOperator

Employment OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used multiplication or division to convert from Employment Payroll Currency to Employment Operating Company Currency.   * multiplication or / division. E.g. if the operator is division then it is Employment Values in Employment Payroll Currency / Employment OperatingCompany Currency Exchange Rate = Employment Values in Employment OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Employment OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Employment Payroll Currency to Employment Operating Company Currency, if different.   Default = System date  

payrollSalary

decimal

Employment Payroll Salary

 

X

 

 

 

Salary applicable to the Payroll associated with this Employment.   In Employment Payroll currency.  

payrollSalaryPer

employmentPayrollSalaryPer

Employment Payroll Salary Per

 

X

 

 

 

What the salary is applicable to e.g. per Hour, per Day, etc.    

cumulativePayrollSalary

decimal

Employment Cumulative Payroll Salary

 

 

 

 

 

Total of all salary/Payroll for the current Employment Period usually fiscal year.   In Employment Payroll currency  

cumulativeTax

decimal

Employment Cumulative Tax

 

 

 

 

 

Total of all Tax for the current Employment Period usually fiscal year.   In Employment Payroll currency  

cumulativeBenefit

decimal

Employment Cumulative Benefit

 

X

 

 

 

Total of all Benefits for the current Period usually fiscal year.   In Employment Payroll currency  

cumulativeDeduction

decimal

Employment Cumulative Deduction

 

X

 

 

 

Total of all Deductions for the current Employment Period usually fiscal year.   In Employment Payroll currency  

workObligation

decimal

Employment Work Obligation

 

X

 

 

 

The work obligation associated with the Employment and the Payroll, e.g. 35 hours per week, 12 months per year.    

workObligationPer

employmentWorkObligationPer

Employment Work Obligation Per

 

X

 

 

 

What the work obligation is applicable to e.g. per Hour, per Day, etc.    

cumulativeWorkObligation

decimal

Employment Cumulative Work Obligation

 

 

 

 

 

Total of all Work Obligations for the current Employment Period usually fiscal year.    

maximumWork

normalizedString

Employment Maximum Work

 

X

 

 

 

The maximum amount of work permitted in association with the Employment contract, expressed maximum work units but see Employee Working Time Reg Opt Out Flag on Employee record – this allows an Employee to exceed maximum work where legislation allows    

maximumWorkPer

employmentMaximumWorkPer

Employment Maximum Work Per

 

X

 

 

 

What the maximum work is applicable to e.g. per Hour, per Day, etc.    

holidayEntitlement

decimal

Employment Holiday Entitlement

 

X

 

 

 

The holiday vacation entitlement associated with the Employment e.g. 25 days – CURRENT ACCUMULATION.    

holidayEntitlementPer

employmentHolidayEntitlementPer

Employment Holiday Entitlement Per

 

X

 

 

 

What the holiday entitlement is applicable to e.g. per Hour, per Day, etc.    

cumulativeHoliday

decimal

Employment Cumulative Holiday

 

 

 

 

 

Total of all Holiday for the current Employment Period usually fiscal year.    

holidayRolloverAllowed

boolean

Employment Holiday Rollover Allowed Flag

 

X

 

 

 

Flag to indicate if Holiday entitlement can be rolled over or carried forward e.g. from current year to next year.    

holidayRolloverEntitlement

decimal

Employment Holiday Rollover Entitlement

 

X

 

 

 

The holiday vacation entitlement rolled over from previous periods if allowed e.g. 25 days.   In Holiday Entitlement Per unit.  

holidayRolloverMaximumEntitlement

decimal

Employment Holiday Rollover Maximum Entitlement

 

X

 

 

 

The maximum holiday vacation entitlement that can be rolled over from previous periods if allowed e.g. 5 days.   In Holiday Entitlement Per unit.  

cumulativeHolidayRollover

decimal

Employment Cumulative Holiday Rollover

 

 

 

 

 

Total of all Rollover Holiday taken for the current Employment Period usually fiscal year.   In Holiday Entitlement Per unit. Default to zero if not used  

holidayRolloverExpiry

date

Employment Holiday Rollover Expiry

 

X

 

 

 

Date any Holiday entitlement rolled over or carried forward e.g. from current year to next year expires.    

earnedHolidayAllowed

boolean

Employment Earned Holiday Allowed Flag

 

X

 

 

 

Flag to indicate if earned Holiday time off in lieu – TOIL is allowed.    

earnedHolidayEntitlement

decimal

Employment Earned Holiday Entitlement

 

X

 

 

 

The earned holiday vacation current entitlement e.g. 3 days.   In Holiday Entitlement Per unit.  

earnedHolidayMaximumEntitlement

decimal

Employment Earned Holiday Maximum Entitlement

 

X

 

 

 

The maximum amount of earned holiday vacation that can be earned e.g. 5 days.   In Holiday Entitlement Per unit.  

cumulativeEarnedHoliday

decimal

Employment Cumulative Earned Holiday

 

 

 

 

 

Total of all earned Holiday taken for the current Employment Period usually fiscal year.   In Holiday Entitlement Per unit. Default to zero if not used  

earnedHolidayExpiry

date

Employment Earned Holiday Expiry

 

X

 

 

 

Date any earned Holiday expires.    

sicknessEntitlement

decimal

Employment Sickness Entitlement

 

X

 

 

 

The sickness entitlement associated with the Employment e.g. 0 days.    

sicknessEntitlementPer

employmentSicknessEntitlementPer

Employment Sickness Entitlement Per

 

X

 

 

 

What the sickness entitlement is applicable to e.g. per Hour, per Day, etc.    

cumulativeSickness

decimal

Employment Cumulative Sickness

 

 

 

 

 

Total of all Sickness for the current Employment Period usually fiscal year.    

absenceEntitlement

decimal

Employment Absence Entitlement

 

X

 

 

 

The absence entitlement associated with the Employment e.g. 3 days.    

absenceEntitlementPer

employmentAbsenceEntitlementPer

Employment Absence Entitlement Per

 

X

 

 

 

What the absence entitlement is applicable to e.g. per Hour, per Day, etc.    

cumulativeAbsence

decimal

Employment Cumulative Absence

 

 

 

 

 

Total of all Absence Entitlement for the current Employment Period usually fiscal year.    

primacyIndicator

boolean

Employment Primacy Indicator

 

 

 

 

 

A flag to indicate if the Employment is the primary/default Employment for the Employee.   Only one can have primacy. Default = False  

statisticalAnalysisCode

normalizedString

Employment Statistical Analysis Code

 

X

 

 

 

Where Employment contracts are statistically analysed e.g. by government, then this will hold the code.    

collectiveAgreementCode

normalizedString

Employment Collective Agreement Code

 

X

 

 

 

Code referring to the collective e.g. union, minimum wage agreement in place for the Employment.    

mobilityRequired

boolean

Employment Mobility Required

 

X

 

 

 

Flag to indicate if geographic mobility is required as part of the Employment.   Default=False  

competitorConstraint

boolean

Employment Competitor Constraint

 

X

 

 

 

Flag to indicate if there is a competitor constraint in place against the Employment e.g. must not work for a competitor organization.   Default=False  

associatedEmployments

employment*

Employment Associated Employments

 

X

 

 

association 

A link to other Employments contracts associated with this Employment .e.g for contract renewals.    

financialAccounts

financialAccount*

Employment FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Employment.   See FinancialAccount definition.  

costCentres

costCentre*

Employment CostCentre

 

X

 

 

association 

 

departments

department*

Employment Department

 

X

 

 

association 

 

notes

note*

Employment Note

 

X

 

 

child 

Notes associated with an Employment.    

Top  

Resource candidate

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Candidate Active Flag

 

 

 

 

 

Flag to indicate if the Candidate is an active Candidate.    

reference

normalizedString

Candidate Reference

X

 

 

 

 

Reference for the Candidate e.g. Candidate/Payroll number.    

reference2

normalizedString

Candidate Reference2

 

X

 

 

 

Additional reference for the Candidate.    

status

normalizedString

Candidate Status

 

X

 

 

 

Status of the Candidate.    

type

normalizedString

Candidate Type

 

X

 

 

 

The Candidate type e.g. Full Time, Part Time, etc.    

gender

normalizedString

Candidate Gender

 

X

 

 

 

The gender of the Candidate e.g. Male, Female, Not Specified.    

fullName

normalizedString

Candidate Full Name

 

 

 

X

 

The full name of the Candidate e.g. title, first name, family name, suitably spaced.   Formatted name for display purposes.  

salutation

normalizedString

Candidate Salutation

 

X

 

 

 

The salutation to be used when addressing the Candidate Dear, Your Excellency, etc.    

firstName

normalizedString

Candidate First Name

 

X

 

 

 

The first name of the Candidate.    

preferredName

normalizedString

Candidate Preferred Name

 

X

 

 

 

The name preferred by the Candidate – may be first name or a nick name.   Could use First Name as default  

familyName

normalizedString

Candidate Family Name

 

X

 

 

 

The family name surname of the Candidate.    

previousFamilyName

normalizedString

Candidate Previous Family name

 

X

 

 

 

Any previous family name used by the Candidate before marriage.    

title

normalizedString

Candidate Title

 

X

 

 

 

The title of the Candidate.   Language-specific  

middleName

normalizedString

Candidate Middle Name

 

X

 

 

 

The middle name of the Candidate.    

suffix

normalizedString

Candidate Suffix

 

X

 

 

 

A name suffix associated with the .Candidate e.g. PhD, OBE, etc    

resumes

resume*

Candidate Resume

 

X

 

 

association 

Link to the Candidates Resumes   See Resume definition.  

competencies

competency*

Candidate Competency

 

X

 

 

association 

A link to the Competencies shown by the Candidate   See Competency definition.  

age

decimal

Candidate Age

 

X

 

 

 

The age of the Candidate.   Could be calculated from date of birth.  

dateOfBirth

date

Candidate Date Of Birth

 

X

 

 

 

The date of birth of the Candidate.    

nationality

normalizedString

Candidate Nationality

 

X

 

 

 

The nationality of the Candidate.    

language

normalizedString

Candidate Language

 

X

 

 

 

Language used spoken by the Candidate e.g. EN-GB.   ISO 639  

maritalStatus

normalizedString

Candidate Marital Status

 

X

 

 

 

The marital status single, married, etc of the Candidate.    

countryOfResidence

normalizedString

Candidate Country of Residence

 

X

 

 

 

The country of residence of the Candidate.   ISO 3166-1 alpha-2 country codes only  

ethnicOrigin

normalizedString

Candidate Ethnic Origin

 

X

 

 

 

The ethnic origin of the Candidate.    

faith

normalizedString

Candidate Faith

 

X

 

 

 

The faith of the Candidate.    

disabilityFlag

boolean

Candidate Disability Flag

 

X

 

 

 

A flag to indicate if the Candidate is registered disabled.    

disabilityValue

decimal

Candidate Disability Value

 

X

 

 

 

A numeric value associated with the Candidate disability if applicable.    

disabilityText

normalizedString

Candidate Disability Text

 

X

 

 

 

A text value associated with the Candidate disability if applicable.    

disabilityStartDate

date

Candidate Disability Start Date

 

X

 

 

 

A start date associated with the Candidate disability if applicable.    

disabilityEndDate

date

Candidate Disability End Date

 

X

 

 

 

An end date associated with the Candidate disability if applicable.    

nationalInsuranceNumber

normalizedString

Candidate National Insurance Number

 

X

 

 

 

The national insurance, or country-specific equivalent, number.    

taxReference

normalizedString

Candidate Tax Reference

 

X

 

 

 

Reference number for tax purposes of the Candidate e.g. UK UTR.    

taxCodes

taxCode*

Candidate Tax Code

 

X

 

 

association 

Code used for the calculation of taxes for the Candidate.   In the UK this is known as the Tax Code.  

postalAddresses

postalAddress*

Candidate PostalAddresses

 

X

 

 

child 

Link to the Candidate addresses e.g. home address.   See PostalAddress definition.  

phones

phoneNumber*

Candidate Phones

 

X

 

 

child 

Candidate telephone numbers.   See PhoneNumber definition.  

emails

email*

Candidate Emails

 

X

 

 

child 

Candidate email addresses.   See Email definition.  

website

normalizedString

Candidate Web site

 

X

 

 

 

Candidate web site address.    

vacancy

vacancy

Candidate Vacancy

 

X

 

 

reference 

Vacancy the Candidate is applying for.   See Vacancy definition.  

applicationDate

date

Candidate Application Date

 

X

 

 

 

The date the Candidate applied.    

background

normalizedString

Candidate Background

 

X

 

 

 

Details of any background checks carried out against the Candidate.    

supplier

tradingAccount

Candidate Supplier

 

X

 

 

reference 

Link to the Supplier associated with the Candidate e.g. recruitment agency supplying Candidate details.   See Supplier definition. CRM schema.  

over18Flag

boolean

Candidate Over 18 Flag

 

X

 

 

 

Flag to indicate if Candidate is over 18.   Default = True If DOB available then this could be derived.  

eligibleToWorkFlag

boolean

Candidate Eligible To Work Flag

 

X

 

 

 

Flag to indicate Candidate is eligible for work e.g. in USA/EU.   Default = True  

hasConvictionsFlag

boolean

Candidate Has Convictions Flag

 

X

 

 

 

Flag to indicate if Candidate has any criminal convictions felonies.   Default = False  

convictionsText

normalizedString

Candidate Conviction Text

 

X

 

 

 

Text associated with any criminal convictions declared by the candidate.    

notes

note*

Candidate Note

 

X

 

 

child 

Notes associated with a Candidate.    

Top  

Resource competency

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Competency Active Flag

 

 

 

 

 

Flag to indicate if the Competency is an active Competency .    

competencyGroups

competencyGroup*

Competency CompetencyGroups

 

 

 

 

association 

Link to the Competency Groups this Competency belongs to.   See CompetencyGroup definition.  

operatingCompany

operatingCompany

Competency OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Competency.   See OperatingCompany definition Company where type = Operating Company.  

reference

normalizedString

Competency Reference

X

 

 

 

 

Reference for the Competency e.g. BI 1.    

reference2

normalizedString

Competency Reference2

 

X

 

 

 

Additional reference for the Competency.    

status

competencyStatus

Competency Status

 

X

 

 

 

Status of the Competency.    

name

normalizedString

Competency Name

 

 

 

 

 

The Competency name e.g. Leadership, Commercial Awareness, Delivering Results, Customer Focus,etc    

text1

string

Competency Text1

 

X

 

 

 

Textual information associated with the Competency.    

text2

string

Competency Text2

 

X

 

 

 

Textual information associated with the Competency.    

type

competencyType

Competency Type

 

 

 

 

 

The Competency type.    

employee

employee

Competency Employee

 

X

 

 

reference 

A link to the Employee associated with this Competency see Status above.   See Employee definition.  

levelNumber

decimal

Competency Level Number

 

X

 

 

 

The level associated with the Position within the Competency in numeric format e.g. 1-5 in the Sage UK Competency Index.   Default = 1 If this is associated with an Employee and has Status = Achieved then this will be the level achieved by the Employee.  

levelText

normalizedString

Competency Level Text

 

X

 

 

 

The level associated with the Position within the Competency – in textual format e.g. for some academic qualifications there may be alphabetic grades A-F, etc.   If this is associated with an Employee and has Status = Achieved then this will be the level achieved by the Employee.  

associatedParentCompetency

competency

Competency Associated Parent Competency

 

X

 

 

parent 

Link to Parent Competency associated with this Competency.   Competencies are often sequential representing improvement in a particular Competency.  

associatedChildCompetencies

competency*

Competency Associated Child Competency

 

X

 

 

child 

Link to Child Competency associated with this Competency   Competencies are often sequential representing improvement in a particular Competency.  

evidenceText1

string

Competency Evidence Text1

 

X

 

 

 

Textual information associated with the evidence of the Competency.    

evidenceNumeric1

decimal

Competency Evidence Numeric1

 

X

 

 

 

Numeric information associated with the evidence of the Competency e.g. a level or degree classification.    

evidenceText2

string

Competency Evidence Text2

 

X

 

 

 

Textual information associated with the Competency.    

evidenceNumeric2

decimal

Competency Evidence Numeric2

 

X

 

 

 

Numeric information associated with the evidence of the Competency e.g. a level or degree classification.    

startDate

date

Competency Start Date

 

X

 

 

 

Date upon which a Competency started or was achieved by an associated Employee.    

duration

decimal

Competency Duration

 

X

 

 

 

Duration of a Competency e.g. 3 years    

durationUnit

competencyDurationUnit

Competency Duration Unit

 

X

 

 

 

Unit associated with the Competency duration e.g. Years.    

expiryDate

date

Competency Expiry Date

 

X

 

 

 

Date upon which a Competency expires if associated with an Employee and the Competency needs to be regularly updated.    

notes

note*

Competency Note

 

X

 

 

child 

Notes associated with a Competency.    

Top  

Resource competencyGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

competencies

competency*

CompetencyGroup Competency

 

 

 

 

association 

Link to the Competencies within the Competency Group.   See Competency definition.  

active

boolean

CompetencyGroup Active Flag

 

 

 

 

 

Flag to indicate if the CompetencyGroup is an active CompetencyGroup .    

operatingCompany

operatingCompany

CompetencyGroup OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the CompetencyGroup.   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

CompetencyGroup Name

 

X

 

X

 

Name for the CompetencyGroup as used by the Operating Company e.g. Sage UK CompetencyGroup Index.    

reference

normalizedString

CompetencyGroup Reference

X

 

 

 

 

Reference for the CompetencyGroup e.g. BI 1.    

reference2

normalizedString

CompetencyGroup Reference2

 

X

 

 

 

Additional reference for the CompetencyGroup.    

type

competencyGroupType

CompetencyGroup Type

 

 

 

 

 

The CompetencyGroup type.    

levelNumberFrom

decimal

CompetencyGroup Level Number From

 

 

 

 

 

The scale start level associated with the CompetencyGroup in numeric format e.g. 1 in the Sage UK Competency Index.   Default = 1  

levelNumberTo

decimal

CompetencyGroup Level Number To

 

 

 

 

 

The scale end level associated with the CompetencyGroup in numeric format e.g. 5 in the Sage UK Competency Index.   Default = 1  

levelNumberSort

competencyGroupLevelNumberSort

CompetencyGroup Level Number Sort

 

 

 

 

 

A value ascending or descending associated with the start and end levels of the Competency this is Ascending for the Sage UK Competency Index which runs from 1-5.    

notes

note*

CompetencyGroup Note

 

X

 

 

child 

Notes associated with a CompetencyGroup.    

Top  

Resource workplace

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Workplace Active Flag

 

 

 

 

 

Flag to indicate if the Workplace is an active one .    

reference

normalizedString

Workplace Reference

X

 

 

 

 

Reference for the Workplace typically the one used by the buying organization.    

reference2

normalizedString

Workplace Reference2

 

X

 

 

 

Another reference for the Workplace.    

status

normalizedString

Workplace Status

 

X

 

 

 

Status of the Workplace e.g. Open, Closed.    

name

normalizedString

Workplace Name

 

 

 

X

 

Short name for the Workplace.    

shortName

normalizedString

Workplace Short Name

 

X

 

 

 

A shorter name for the Workplace.    

description

normalizedString

Workplace Description

 

X

 

 

 

The Workplace description.    

alternativeDescription1

normalizedString

Workplace Alternative Description 1

 

X

 

 

 

An alternative Workplace description.    

alternativeDescription2

normalizedString

Workplace Alternative Description 2

 

X

 

 

 

Another alternative Workplace description    

type

normalizedString

Workplace Type

 

 

 

 

 

The type of Workplace, e.g. Office, Warehouse, Building Site, etc    

operatingCompany

operatingCompany

Workplace OperatingCompany

 

 

 

 

reference 

A link to the OperatingCompany associated with this Workplace.   See OperatingCompany definition Company where type = Operating Company.  

postalAddress

postalAddress

Workplace PostalAddress

 

X

 

 

child 

Link to the Workplace address.   See PostalAddress definition.  

taxCodes

taxCode*

Workplace Tax Code

 

X

 

 

association 

Tax code governing the tax treatment of this Workplace e.g. for payroll taxes – in some scenarios this may over-ride Employee Tax Code.   See TaxCode definition.  

nationalInsuranceNumber

normalizedString

Workplace National Insurance Number

 

X

 

 

 

The national insurance, or country-specific equivalent, number, for the workplace.    

openingDays

normalizedString

Workplace Opening Days

 

X

 

 

 

Details of opening times for the Workplace e.g. when deliveries can be accepted.    

openingTimes

dateTime

Workplace Opening Times

 

X

 

 

 

Details of opening times for the Workplace e.g. when deliveries can be accepted.    

gPSPosition

normalizedString

Workplace GPS Position

 

X

 

 

 

A GPS position for the Workplace useful for web or sat nav mobile device integration.    

phones

phoneNumber*

Workplace Phones

 

X

 

 

child 

Workplace telephone numbers.   See PhoneNumber definition.  

emails

email*

Workplace Emails

 

X

 

 

child 

Workplace email addresses.   See Email definition.  

website

normalizedString

Workplace Web site

 

X

 

 

 

Workplace web site address.    

employees

employee*

Workplace Employee

 

X

 

 

association 

Link to the Employeess associated with the Workplace.   See Employee definition.  

financialAccounts

financialAccount*

Workplace Financial Account

 

X

 

 

association 

Financial Account associated with the Workplace.   See FinancialAccount definition.  

costCentres

costCentre*

Workplace CostCentre

 

X

 

 

association 

 

departments

department*

Workplace Department

 

X

 

 

association 

 

primacyIndicator

boolean

Workplace Primacy Indicator

 

 

 

 

 

A flag to indicate if the Workplace is the primary/default Workplace.   One only can have Primacy against an associated entity e.g. Employee, Position, etc. Default = False  

incidents

incident*

Workplace Incident

 

X

 

 

association 

Link to any Incidents association with the Workplace.   See Incident definition.  

associatedChildWorkplace

workplace*

Workplace Associated Child Workplace

 

X

 

 

child 

Link to Child Workplace associated with this Workplace. Workplaces can be nested to create workplace hierarchies e.g. site, office, floor, office. 

associatedParentWorkplace

workplace

Workplace Associated Parent Workplace

 

X

 

 

parent 

Link to Parent Workplace associated with this Workplace. Workplaces can be nested to create workplace hierarchies e.g. site, office, floor, office. 

notes

note*

Workplace Note

 

X

 

 

child 

Notes associated with a Workplace.    

Top  

Resource resume

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Resume Active Flag

 

 

 

 

 

Flag to indicate if the Resume is an active one .    

type

resumeType

Resume Type

 

X

 

 

 

The resume type actual for Employees or application for Candidates.    

reference

normalizedString

Resume Reference

X

 

 

 

 

Reference for the Resume.    

reference2

normalizedString

Resume Reference2

 

X

 

 

 

Another reference for the Resume.    

name

normalizedString

Resume Name

 

 

 

 

 

Name of the Resume.    

candidate

candidate

Resume Candidate

 

X

 

 

reference 

Candidates associated with the Resume if Type = Application.   See Employee definition.  

employees

employee*

Resume Employees

 

X

 

 

association 

Link to the Employees associated with the Resume if Type = Actual.   See Employee definition.  

executiveSummary

string

Resume Executive Summary

 

X

 

 

 

A text field where the contents of the resume can be briefly summarized.    

objective

string

Resume Objective

 

X

 

 

 

The description of the job or position being sought, or information about the Candidates desired career path or professional objectives.    

employmentHistory

string

Resume Employment History

 

X

 

 

 

Employment history for the Candidate or Employee    

assignmentHistory

string

Resume Assignment History

 

X

 

 

 

Internal Assignment history for the Employee    

educationHistory

string

Resume Education History

 

X

 

 

 

Education history for the Candidate or Employee    

militaryHistory

string

Resume Military History

 

X

 

 

 

Military history e.g. national service for the Candidate or Employee    

patentHistory

string

Resume Patent History

 

X

 

 

 

Patent history for the Candidate or Employee    

publicationHistory

string

Resume Publication History

 

X

 

 

 

Publication books, articles, etc history for the Candidate or Employee    

presentationHistory

string

Resume Presentation History

 

X

 

 

 

Presentation history e.g. speaking events for the Candidate or Employee    

qualificationsText

string

Resume Qualifications Text

 

X

 

 

 

Contains the qualifications of the Candidate or Employee. This includes their skills and other applicable comments.    

qualificationsCompetencies

competency*

Resume Qualifications Competency

 

X

 

 

association 

Contains the qualifications of the Employee expressed as Competencies/.   See Competency definition  

language1

normalizedString

Resume Language 1

 

X

 

 

 

Language used by the Employee or Candidate e.g. EN-GB   ISO 639 Languages may also be tracked as Competencies.  

language2

normalizedString

Resume Language 2

 

X

 

 

 

Language used by the Employee or Candidate   ISO 639 Languages may also be tracked as Competencies.  

language3

normalizedString

Resume Language 3

 

X

 

 

 

Language used by the Employee or Candidate   ISO 639 Languages may also be tracked as Competencies.  

language4

normalizedString

Resume Language 4

 

X

 

 

 

Language used by the Employee or Candidate   ISO 639 Languages may also be tracked as Competencies.  

achievements

string

Resume Achievements

 

X

 

 

 

Major achievements for the Candidate or Employee    

additionalItem

string

Resume Additional Item

 

X

 

 

 

Used to accommodate a wide variety of information that might be included on a resume    

supportingMaterials

string

Resume Supporting Materials

 

X

 

 

 

Supporting materials in connection with the Resume.    

professionalAssociations

string

Resume Professional Associations

 

X

 

 

 

Details of any professional associations held by the Candidate or Employee.    

comments

string

Resume Comments

 

X

 

 

 

Additional Resume comments.    

date

date

Resume Date

 

X

 

 

 

Date of the Resume    

version

decimal

Resume Version

 

X

 

 

 

Version number associated with the Resume, if it is continually updated.    

url

normalizedString

Resume URL

 

X

 

 

 

A link to a web page/site associated with the Resume e.g. where it is stored or where it was received from.    

videoURL

normalizedString

Resume Video URL

 

X

 

 

 

A link to a web page/site associated with a video version of the Resume e.g. a social networking site.    

primacyIndicator

boolean

Resume Primacy Indicator

 

 

 

 

 

Flag to indicate if this is the Primary Resume e.g. for the Candidate or Employee where there are multiple.    

securityCredentials

string

Resume Security Credentials

 

X

 

 

 

Security credentials for the Candidate or Employee e.g. Ministry of Defence Clearance.    

securityCredentialsIssuingAuthority

normalizedString

Resume Security Credentials Issuing Authority

 

X

 

 

 

Authority who issues the security credentials e.g. MOD.    

securityCredentialsExpiryDate

date

Resume Security Credentials Expiry Date

 

X

 

 

 

Date the security credentials will expire.    

notes

note*

Resume Note

 

X

 

 

child 

Notes Reference with the Resume.   See Note definition.  

Top  

Resource timesheet

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Timesheet Active Flag

 

 

 

 

 

Flag to indicate if the Timesheet is an active one .    

reference

normalizedString

Timesheet Reference

X

 

 

 

 

Reference for the Timesheet.    

reference2

normalizedString

Timesheet Reference2

 

X

 

 

 

Additional reference for the Timesheet.    

status

timesheetStatus

Timesheet Status

 

X

 

 

 

Status of the Timesheet    

statusFlag

boolean

Timesheet Status Flag

 

X

 

 

 

Additional Boolean status flag e.g. Timesheet on hold or blocked, off hold.   True is on hold, False is not on hold.  

statusFlagText

normalizedString

Timesheet Status Flag Text

 

X

 

 

 

Timesheet status flag text.    

operatingCompany

operatingCompany

Timesheet OperatingCompany

 

X

 

 

reference 

OperatingCompany associated with the Timesheet   See OperatingCompany definition Company where type = Operating Company.  

employee

employee

Timesheet Employee

 

X

 

 

reference 

Employee associated with the Timesheet   See Employee definition.  

employeeReference

normalizedString

Timesheet Employee Reference

 

X

 

 

 

Employees own reference for the Timesheet.    

entryDate

date

Timesheet Entry Date

 

 

 

X

 

Date the Timesheet document was raised.    

entryTime

time

Timesheet Entry Time

 

X

 

 

 

Time the Timesheet document was raised.    

currency

normalizedString

Timesheet Currency

 

 

 

 

 

The currency e.g. GBP, USD, EUR used on the Timesheet.   ISO 4217.  

operatingCompanyCurrency

normalizedString

Timesheet OperatingCompany Currency

 

 

 

 

 

The currency as used by the Operating Company, the business operating the Sage application the base currency.   ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Timesheet OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Timesheet Currency into Timesheet Operating Company Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

timesheetOperatingCompanyCurrencyExchangeRateOperator

Timesheet OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used multiplication or division to convert from Timesheet Currency to Timesheet OperatingCompany Currency.   * multiplication or / division. E.g. if the operator is division then it is Timesheet Values in Timesheet Currency / Timesheet Operating Company Currency Exchange Rate = Timesheet Values in Timesheet Operating Company currency.  

operatingCompanyCurrencyExchangeRateDate

date

Timesheet OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Timesheet Currency to Timesheet OperatingCompany Currency, if different.   Default = System date  

timesheetLines

timesheetLine*

Timesheet TimesheetLine

 

 

 

 

child 

Timesheet Line detail.   See TimesheetLine definition.  

lineCount

decimal

Timesheet Line Count

 

 

 

 

 

The number of lines on the Timesheet.   Should be auto-populated. Used as a cross reference to ensure Document integrity.  

financialRevenueTotal

decimal

Timesheet Financial Revenue Total

 

X

 

 

 

Total financial revenue value of the Timesheet.   In Timesheet currency.  

financialCostTotal

decimal

Timesheet Financial Cost Total

 

X

 

 

 

Total financial cost value of the Timesheet.   In Timesheet currency.  

payrollPayTotal

decimal

Timesheet Payroll Pay Total

 

X

 

 

 

Total payroll pay value of the Timesheet.   In Timesheet currency.  

unitTotal

decimal

Timesheet Unit Total

 

 

 

 

 

Total unit value of the Timesheet.   In Timesheet currency.  

unit

timesheetUnit

Timesheet Unit

 

 

 

 

 

Unit used on the Timesheet.   This may be different by line.  

payrolls

payroll*

Timesheet Payroll

 

X

 

 

association 

If the Timesheet forms part of a Payroll then this is a link to the Payroll entry.   See Payroll definition.  

unitFinancialRevenueRate

decimal

Timesheet Unit Financial Revenue Rate

 

X

 

 

 

The financial revenue rate for 1 unit used on the Timesheet.   In Timesheet currency. This may be different by line.  

unitFinancialCostRate

decimal

Timesheet Unit Financial Cost Rate

 

X

 

 

 

The financial cost rate for 1 unit used on the Timesheet.   In Timesheet currency. This may be different by line.  

unitPayrollPayRate

decimal

Timesheet Unit Payroll Pay Rate

 

X

 

 

 

The payroll pay rate for 1 unit used on the Timesheet.   In Timesheet currency. This may be different by line.  

text1

string

Timesheet Text1

 

X

 

 

 

Text/commentary on the Timesheet.   Header text  

text2

string

Timesheet Text2

 

X

 

 

 

Text/commentary on the Timesheet.   Footer text  

projects

project*

Timesheet Project

 

X

 

 

association 

Identifier of the Project this Timesheet is for – usually on the Timesheet Line.   See Project definition. CRM schema  

projectLines

projectLine*

Timesheet ProjectLine

 

X

 

 

association 

Project Line value for this Timesheet – usually on the Timesheet Line.   See Project Line definition. CRM schema Some applications may not have Project Lines.  

caseReferences

case*

Timesheet Case Reference

 

X

 

 

association 

The reference of the case associated with the Timesheet e.g. if the Document is for repair/fix services – usually on the Timesheet Line.   See Case definition. CRM schema  

financialAccounts

financialAccount*

Timesheet FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Timesheet – usually on the Timesheet Line.   See FinancialAccount definition.  

costCentres

costCentre*

Timesheet CostCentre

 

X

 

 

association 

 

departments

department*

Timesheet Department

 

X

 

 

association 

 

interactions

interaction*

Timesheet Interaction

 

X

 

 

association 

Interactions associated with the Timesheet.   See Interaction definition. CRM schema  

notes

note*

Timesheet Note

 

X

 

 

child 

Notes associated with a Timesheet.    

Top  

Resource timesheetLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

activeFlag

boolean

TimesheetLine Active Flag

 

 

 

 

 

Flag to indicate if the Timesheet Line is an active one.    

reference

normalizedString

TimesheetLine Reference

X

 

 

 

 

Reference for the Timesheet.    

reference2

normalizedString

TimesheetLine Reference2

 

X

 

 

 

Additional reference for the Timesheet.    

timeType

timesheetLineTimeType

TimesheetLine Time Type

 

 

 

 

 

The type of time on the TimesheetLine e.g. Work, Absence. Further information on Absence types are given in the Absence resource.    

status

timesheetLineStatus

TimesheetLine Status

 

X

 

 

 

Status of the Timesheet Line.    

number

decimal

TimesheetLine Number

 

 

 

 

 

The number of the Timesheet Line.   For sequencing and ordering of lines.  

text

string

TimesheetLine Text

 

X

 

 

 

Text applicable to the Timesheet Line.    

date

date

TimesheetLine Date

 

X

 

 

 

The date of the Timesheet Line.    

startTime

time

Timesheet StartTime

 

X

 

 

 

The start time of the Timesheet Line if time is tracked to this level of detail.    

endTime

time

Timesheet EndTime

 

X

 

 

 

The end time of the Timesheet Line if time is tracked to this level of detail.    

applicableDate

date

TimesheetLine Applicable Date

 

X

 

 

 

The date the Timesheet Line is applicable to if entered after the event.   This may be used when time could not be accurately recorded at the time, and was entered at a later date e.g. when the previous period was closed.  

unitQuantity

decimal

TimesheetLine Unit Quantity

 

 

 

 

 

The quantity of the Timesheet Line.   Default to 1 if not used. In TimesheetLine Unit.  

unit

timesheetLineUnit

TimesheetLine Unit

 

 

 

 

 

Unit used on the Timesheet Line.    

unitFinancialRevenueRate

decimal

TimesheetLine Unit Financial Revenue Rate

 

X

 

 

 

The financial revenue rate for 1 unit used on the Timesheet Line.   In Timesheet currency.  

unitFinancialCostRate

decimal

TimesheetLine Unit Financial Cost Rate

 

X

 

 

 

The financial cost rate for 1 unit used on the Timesheet Line.   In Timesheet currency.  

unitPayrollPayRate

decimal

TimesheetLine Unit Payroll Pay Rate

 

X

 

 

 

The payroll pay rate for 1 unit used on the Timesheet Line.   In Timesheet currency.  

financialRevenueTotal

decimal

TimesheetLine Financial Revenue Total

 

X

 

 

 

Total financial revenue value of the Timesheet Line.   In Timesheet currency. Could be calculated TimesheetLine Unit Quantity * TimesheetLine Unit Financial Revenue Rate.  

financialCostTotal

decimal

TimesheetLine Financial Cost Total

 

X

 

 

 

Total financial cost value of the Timesheet Line.   In Timesheet currency. Could be calculated TimesheetLine Unit Quantity * TimesheetLine Unit Financial Cost Rate.  

payrollPayTotal

decimal

TimesheetLine Payroll Pay Total

 

X

 

 

 

Total payroll pay value of the Timesheet Line.   In Timesheet currency. Could be calculated TimesheetLine Unit Quantity * TimesheetLine Unit Payroll Pay Rate.  

project

project

TimesheetLine Project

 

X

 

 

reference 

Identifier of the Project this Timesheet Line is for if any.   See Project definition. CRM schema  

projectLine

projectLine

TimesheetLine ProjectLine

 

X

 

 

reference 

Project Line value for this Timesheet Line.   See Project Line definition. CRM schema Some applications may not have Project Lines.  

payrollElement

payrollElement

TimesheetLine Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to the Timesheet Line.   See PayrollElement definition  

payrolls

payroll*

TimesheetLine Payroll

 

X

 

 

association 

If the Timesheet Line forms part of a Payroll then this is a link to the Payroll entry.   See Payroll definition.  

payrollLines

payrollLine*

TimesheetLine PayrollLine

 

X

 

 

association 

If the Timesheet Line forms part of a Payroll then this is a link to the Payroll Line entry.   See PayrollLine definition.  

financialAccounts

financialAccount*

TimesheetLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Timesheet Line.   See FinancialAccount definition.  

costCentres

costCentre*

TimesheetLine CostCentre

 

X

 

 

association 

 

departments

department*

TimesheetLine Department

 

X

 

 

association 

 

workplace

workplace

TimesheetLine Workplace

 

X

 

 

reference 

If the Timesheet Line is associated with a particular Workplace, then this is a link to the Workplace.   See Workplace definition.  

absenceLine

absenceLine

TimesheetLine AbsenceLine

 

X

 

 

reference 

Link to any associated Absence Lines.   See AbsenceLine definition.  

notes

note*

TimesheetLine Note

 

X

 

 

child 

Notes associated with a Timesheet Line e.g. for credit control.    

Top  

Resource expenseClaim

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

ExpenseClaim Active Flag

 

 

 

 

 

Flag to indicate if the ExpenseClaim is an active one.    

reference

normalizedString

ExpenseClaim Reference

X

 

 

 

 

Reference for the ExpenseClaim.    

reference2

normalizedString

ExpenseClaim Reference2

 

X

 

 

 

Additional reference for the ExpenseClaim.    

status

expenseClaimStatus

ExpenseClaim Status

 

X

 

 

 

Status of the ExpenseClaim    

statusFlag

boolean

ExpenseClaim Status Flag

 

X

 

 

 

Additional Boolean status flag e.g. ExpenseClaim on hold or blocked, off hold.   True is on hold, False is not on hold.  

statusFlagText

normalizedString

ExpenseClaim Status Flag Text

 

X

 

 

 

ExpenseClaim status flag text.    

operatingCompany

operatingCompany

ExpenseClaim OperatingCompany

 

X

 

 

reference 

OperatingCompany associated with the ExpenseClaim   See OperatingCompany definition Company where type = Operating Company.  

employee

employee

ExpenseClaim Employee

 

X

 

 

reference 

Employee associated with the ExpenseClaim   See Employee definition.  

employeeReference

normalizedString

ExpenseClaim Employee Reference

 

X

 

 

 

Employees own reference for the ExpenseClaim.    

entryDate

date

ExpenseClaim Entry Date

 

 

 

X

 

Date the ExpenseClaim document was raised.    

entryTime

time

ExpenseClaim Entry Time

 

X

 

 

 

Time the ExpenseClaim document was raised.    

currency

normalizedString

ExpenseClaim Currency

 

 

 

 

 

The currency e.g. GBP, USD, EUR used on the ExpenseClaim.   ISO 4217.  

operatingCompanyCurrency

normalizedString

ExpenseClaim OperatingCompany Currency

 

 

 

 

 

The currency as used by the Operating Company, the business operating the Sage application the base currency.   ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

ExpenseClaim OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from ExpenseClaim Currency into ExpenseClaim Operating Company Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

expenseClaimOperatingCompanyCurrencyExchangeRateOperator

ExpenseClaim OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used multiplication or division to convert from ExpenseClaim Currency to ExpenseClaim OperatingCompany Currency.   * multiplication or / division. E.g. if the operator is division then it is ExpenseClaim Values in ExpenseClaim Currency / ExpenseClaim Operating Company Currency Exchange Rate = ExpenseClaim Values in ExpenseClaim Operating Company currency.  

operatingCompanyCurrencyExchangeRateDate

date

ExpenseClaim OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from ExpenseClaim Currency to ExpenseClaim OperatingCompany Currency, if different.   Default = System date  

expenseClaimLines

expenseClaimLine*

ExpenseClaim ExpenseClaimLine

 

 

 

 

child 

ExpenseClaim Line detail.   See ExpenseClaimLine definition.  

lineCount

decimal

ExpenseClaim Line Count

 

 

 

 

 

The number of lines on the ExpenseClaim.   Should be auto-populated. Used as a cross reference to ensure Document integrity.  

netFinancialTotal

decimal

ExpenseClaim Net Financial Total

 

 

 

 

 

Net financial value of the ExpenseClaim, excluding taxes.   In ExpenseClaim currency.  

taxTotal

decimal

ExpenseClaim Tax Total

 

 

 

 

 

Total tax value of the Expense Claim.   In ExpenseClaim currency.  

grossFinancialTotal

decimal

ExpenseClaim Gross Financial Total

 

 

 

 

 

Total gross financial value of the ExpenseClaim, including taxes.   In ExpenseClaim currency.  

floatTotal

decimal

ExpenseClaim Float Total

 

X

 

 

 

Total value of any float cash advance made/deducted against the Expense Claim.    

paymentTotal

decimal

ExpenseClaim Payment Total

 

 

 

 

 

Total amount paid to the Employee in respect of the Expense Claim e.g. Gross total – Float total, allowing for any non-reimbursable lines.   Default = Gross Total  

chargeTotal

decimal

ExpenseClaim Charge Total

 

 

 

 

 

Total revenue financial value of the ExpenseClaim, after applying uplift/processing charges.   In ExpenseClaim currency.  

payrolls

payroll*

ExpenseClaim Payroll

 

X

 

 

association 

If the ExpenseClaim forms part of a Payroll then this is a link to the Payroll entry.   See Payroll definition.  

payments

payment*

ExpenseClaim Payment

 

X

 

 

association 

If the ExpenseClaim has been re-imbursed then this is a link to the Payment.   See Payment definition.  

text1

string

ExpenseClaim Text1

 

X

 

 

 

Text/commentary on the ExpenseClaim.   Header text  

text2

string

ExpenseClaim Text2

 

X

 

 

 

Text/commentary on the ExpenseClaim.   Footer text  

projects

project*

ExpenseClaim Project

 

X

 

 

association 

Identifier of the Project this ExpenseClaim is for – usually on the ExpenseClaim Line.   See Project definition. CRM schema  

projectLines

projectLine*

ExpenseClaim ProjectLine

 

X

 

 

association 

Project Line value for this ExpenseClaim – usually on the ExpenseClaim Line.   See Project Line definition. CRM schema Some applications may not have Project Lines.  

cases

case*

ExpenseClaim Case Reference

 

X

 

 

association 

The reference of the case associated with the ExpenseClaim e.g. if the Document is for repair/fix services.   See Case definition. CRM schema  

financialAccounts

financialAccount*

ExpenseClaim FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the ExpenseClaim – usually on the ExpenseClaim Line.   See FinancialAccount definition.  

costCentres

costCentre*

ExpenseClaim CostCentre

 

X

 

 

association 

 

departments

department*

ExpenseClaim Department

 

X

 

 

association 

 

interactions

interaction*

ExpenseClaim Interaction

 

X

 

 

association 

Interactions associated with the ExpenseClaim.   See Interaction definition. CRM schema  

notes

note*

ExpenseClaim Note

 

X

 

 

child 

Notes associated with an ExpenseClaim.    

Top  

Resource expenseClaimLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

ExpenseClaimLine Active Flag

 

 

 

 

 

Flag to indicate if the ExpenseClaim Line is an active one.    

reference

normalizedString

ExpenseClaimLine Reference

X

 

 

 

 

Reference for the ExpenseClaim.    

reference2

normalizedString

ExpenseClaimLine Reference2

 

X

 

 

 

Additional reference for the ExpenseClaim.    

status

normalizedString

ExpenseClaimLine Status

 

X

 

 

 

Status of the ExpenseClaim Line.    

number

decimal

ExpenseClaimLine Number

 

 

 

 

 

The number of the ExpenseClaim Line.   For sequencing and ordering of lines.  

text

string

ExpenseClaimLine Text

 

X

 

 

 

Text applicable to the ExpenseClaim Line.    

date

date

ExpenseClaimLine Date

 

X

 

 

 

The date of the ExpenseClaim Line.    

expenseCategory

expenseCategory

ExpenseClaimLine ExpenseCategory

 

 

 

 

reference 

The Category of the Expense Claim Line   See Expense Category definition.  

netFinancialTotal

decimal

ExpenseClaimLine Net Financial Total

 

 

 

 

 

Net financial value of the ExpenseClaimLine, excluding taxes.   In ExpenseClaim currency.  

taxTotal

decimal

ExpenseClaimLine Tax Total

 

 

 

 

 

Total tax value of the Expense Claim Line.   In ExpenseClaim currency.  

grossFinancialTotal

decimal

ExpenseClaimLine Gross Financial Total

 

 

 

 

 

Total gross financial value of the ExpenseClaimLine, including taxes.   In ExpenseClaim currency.  

unitTotal

decimal

ExpenseClaimLine Unit Total

 

 

 

 

 

Total unit value of the ExpenseClaimLine e.g. mileage.   Default = 1  

unit

expenseClaimLineUnit

ExpenseClaimLine Unit

 

X

 

 

 

Unit used on the ExpenseClaimLine from Category.    

unitRate

decimal

ExpenseClaimLine Unit Rate

 

X

 

 

 

The per-unit Rate used on the Expense Claim Line e.g. 30p per mile.   In ExpenseClaim currency.  

chargeableFlag

boolean

ExpenseClaimLine Chargeable Flag

 

X

 

 

 

Flag to indicate if the Expense Claim Line is chargeable billable.   Default = False  

chargeableTotal

decimal

ExpenseClaimLine Chargeable Total

 

X

 

 

 

Total chargeable value of the Expense Claim Line, if the Expense Claim Line is chargeable billable.   In ExpenseClaim currency.  

financialRevenueRate

decimal

ExpenseClaimLine Financial Revenue Rate

 

X

 

 

 

The per-unit Rate to be used on the Expense Claim Line if the Expense Claim Line is chargeable billable.   In ExpenseClaim currency.  

reimbursableFlag

boolean

ExpenseClaimLine Reimbursable Flag

 

 

 

 

 

Flag to indicate if Expense Claim Line is re-imbursable to the Employee.   Default = True  

project

project

ExpenseClaimLine Project

 

X

 

 

reference 

Identifier of the Project this ExpenseClaim Line is for if any.   See Project definition. CRM schema  

projectLine

projectLine

ExpenseClaimLine ProjectLine

 

X

 

 

reference 

Project Line value for this ExpenseClaim Line.   See Project Line definition. CRM schema Some applications may not have Project Lines.  

payrollElement

payrollElement

ExpenseClaimLine Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to the ExpenseClaim Line.   See PayrollElement definition  

payrolls

payroll*

ExpenseClaimLine Payroll

 

X

 

 

association 

If the ExpenseClaim Line forms part of a Payroll then this is a link to the Payroll entry.   See Payroll definition.  

payrollLines

payrollLine*

ExpenseClaimLine PayrollLine

 

X

 

 

association 

If the ExpenseClaim Line forms part of a Payroll then this is a link to the Payroll Line entry.   See PayrollLine definition.  

financialAccounts

financialAccount*

ExpenseClaimLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the ExpenseClaim Line.   See FinancialAccount definition.  

costCentres

costCentre*

ExpenseClaimLine CostCentre

 

X

 

 

association 

 

departments

department*

ExpenseClaimLine Department

 

X

 

 

association 

 

workplace

workplace

ExpenseClaimLine Workplace

 

X

 

 

reference 

If the Expense Claim Line is associated with a particular Workplace, then this is a link to the Workplace.   See Workplace definition.  

notes

note*

ExpenseClaimLine Note

 

X

 

 

child 

Notes associated with an ExpenseClaim Line e.g. for credit control.    

Top  

Resource benefit

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Benefit Active Flag

 

 

 

 

 

Flag to indicate if the Benefit is an active one.    

reference

normalizedString

Benefit Reference

X

 

 

 

 

Reference for the Benefit.    

reference2

normalizedString

Benefit Reference2

 

X

 

 

 

Additional reference for the Benefit this could be the tax year associated with the Benefit.    

status

benefitStatus

Benefit Status

 

X

 

 

 

Status of the Benefit e.g. Live, Completed.    

operatingCompany

operatingCompany

Benefit OperatingCompany

 

X

 

 

reference 

OperatingCompany associated with the Benefit   See OperatingCompany definition Company where type = Operating Company.  

employees

employee*

Benefit Employee

 

X

 

 

association 

Employees receiving the Benefit   See Employee definition.  

employments

employment*

Benefit Employment

 

X

 

 

association 

Employments associated with i.e. entitle to the Benefit   See Employment definition.  

name

normalizedString

Benefit Name

 

 

 

X

 

The name of the Benefit    

externalReference

normalizedString

Benefit External Reference

 

X

 

 

 

Reference for the Benefit e.g. for insurance-type benefits this may be the insurance scheme number.    

reason

normalizedString

Benefit Reason

 

X

 

 

 

The reason the Benefit is provided.    

type

benefitType

Benefit Type

 

X

 

 

 

The Benefit type.    

regulatoryFilingBenefitType

normalizedString

Benefit Regulatory Filing Benefit Type

 

X

 

 

 

Benefit type as mandated by relevant tax authority e.g. in UK this is the P11D benefit type.    

superType

benefitSuperType

Benefit Super Type

 

 

 

 

 

Flag indicating whether the Benefit is in fact a Benefit i.e. something provided to an Employee at the expense of the Operating Company or a Deduction i.e. something that the Employee is paying for.    

associatedVehicle

vehicle

Benefit Associated Vehicle

 

X

 

 

reference 

A link to a Vehicle associated with the Benefit if Benefit involves a Vehicle.   See Vehicle definition.  

associatedFixedAsset

fixedAsset

Benefit Associated Fixed Asset

 

X

 

 

reference 

Where a Benefit involves an Asset e.g. vehicle, computer then this is a link to the asset record.   Fixed Assets are defined in the FAM schema  

frequency

benefitFrequency

Benefit Frequency

 

X

 

 

 

Details of how frequent Benefit is applicable.    

postalAddresses

postalAddress*

Benefit PostalAddresses

 

X

 

 

child 

Link to Postal Addresses associated with the Benefit .   See PostalAddress definition.  

deliveryMethod

benefitDeliveryMethod

Benefit Delivery Method

 

X

 

 

 

Delivery method to be employed for Benefit e.g. Payroll    

supplier

tradingAccount

Benefit Supplier

 

X

 

 

reference 

Link to the Supplier associated with the OperatingCompany that will be the deliverer of the Benefit.   See Supplier definition. CRM schema.  

tradingAccount

tradingAccount

Benefit TradingAccount

 

X

 

 

reference 

Link to the Trading Account associated with the Supplier that will be the deliverer of the Benefit.   See TradingAccount definition. CRM schema.  

unit

benefitUnit

Benefit Unit

 

X

 

 

 

The unit of the Benefit e.g. for holidays or cars this may be Days, for others it may be Monetary.    

vale

decimal

Benefit Value

 

X

 

 

 

The value of the Benefit in the Unit of the Benefit e.g. for holiday-type Benefits the Unit may be days and the value may be 25, for cars that are made available for use this could be the number of days used.    

monetaryValue

decimal

Benefit Monetary Value

 

X

 

 

 

The value in monetary terms of the Benefit e.g. the cost to the Operating Company.   In Benefit currency.  

cashEquivalentValue

decimal

Benefit Cash Equivalent Value

 

X

 

 

 

The cash-equivalent value in monetary terms of the Benefit e.g. benefit to the Employee.   In Benefit currency.  

employeeContributionValue

decimal

Benefit Employee Contribution Value

 

X

 

 

 

Amount made good by the Employee in connection with the Benefit.   In Benefit currency.  

taxableValue

decimal

Benefit Taxable Value

 

X

 

 

 

The taxable value of the Benefit typically Cash Equivalent – Employee Contribution.   In Benefit currency.  

currency

normalizedString

Benefit Currency

 

X

 

 

 

The currency of the Benefit e.g. GBP, USD, EUR.   ISO 4217.  

operatingCompanyCurrency

normalizedString

Benefit OperatingCompany Currency

 

X

 

 

 

The currency as used by the Operating Company, the business operating the Sage application the base currency.   ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

Benefit OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Benefit Currency into Benefit Operating Company Currency, if different.   Default = 1  

operatingCompanyCurrencyExchangeRateOperator

benefitOperatingCompanyCurrencyExchangeRateOperator

Benefit OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used multiplication or division to convert from Benefit Currency to Benefit Operating Company Currency.   * multiplication or / division. E.g. if the operator is division then it is Benefit Values in Benefit Currency / Benefit OperatingCompany Currency Exchange Rate = Benefit Values in Benefit OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Benefit OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Benefit Currency to Benefit Operating Company Currency, if different.   Default = System date  

startDate

date

Benefit Start Date

 

X

 

 

 

Date of commencement of the benefit e.g. this could be the date of issue of a car or the date from which a pension benefit may start.    

effectiveDate

date

Benefit Effective Date

 

X

 

 

 

Date the Benefit is effective if different to start date.    

endDate

date

Benefit End Date

 

X

 

 

 

Date of end of the benefit e.g. this could be the date a car was returned.    

waiverFlag

boolean

Benefit Waiver Flag

 

X

 

 

 

Flag to indicate if the Benefit was waived by the Employee.    

waiverDate

date

Benefit Waiver Date

 

X

 

 

 

If the Benefit was waived then this is the date of waiver.    

specialClauses

string

Benefit Special Clauses

 

X

 

 

 

Any special clauses exclusions that may apply to the Benefit.    

text1

string

Benefit Text1

 

X

 

 

 

Text/commentary for the Benefit    

text2

string

Benefit Text2

 

X

 

 

 

Further text/commentary for the Benefit.    

payrolls

payroll*

Benefit Payroll

 

X

 

 

association 

Payrolls associated with the Benefit e.g. upon which the benefit has been realized.   See Payroll definition.  

payrollLines

payrollLine*

Benefit PayrollLine

 

X

 

 

association 

Payroll Lines associated with the Benefit e.g. upon which the benefit has been realized.   See PayrollLine definition.  

contract

normalizedString

Benefit Contract

 

X

 

 

 

Reference to a contract associated with the Benefit.    

financialAccounts

financialAccount*

Benefit FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Benefit e.g. a cost code.   See FinancialAccount definition.  

costCentres

costCentre*

Benefit CostCentre

 

X

 

 

association 

 

departments

department*

Benefit Department

 

X

 

 

association 

 

payrollElement

payrollElement

Benefit Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to the Benefit.   See PayrollElement definition  

notes

note*

Benefit Note

 

X

 

 

child 

Notes associated with a Benefit.    

Top  

Resource vehicle

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Vehicle Active Flag

 

 

 

 

 

Flag to indicate if the Vehicle is an active one .    

reference

normalizedString

Vehicle Reference

X

 

 

 

 

Reference for the Vehicle    

reference2

normalizedString

Vehicle Reference2

 

X

 

 

 

Additional reference for the Vehicle    

ownership

vehicleOwnership

Vehicle Ownership

 

 

 

 

 

Details on the ownership of the vehicle.    

status

vehicleStatus

Vehicle Status

 

X

 

 

 

Status of the Vehicle    

operatingCompany

operatingCompany

Vehicle OperatingCompany

 

X

 

 

reference 

OperatingCompany associated with the Vehicle   See OperatingCompany definition Company where type = Operating Company.  

employees

employee*

Vehicle Employee

 

X

 

 

association 

Employees receiving the Vehicle   See Employee definition.  

employments

employment*

Vehicle Employment

 

X

 

 

association 

Employments associated with i.e. entitle to the Vehicle   See Employment definition.  

registeredKeeper

normalizedString

Vehicle Registered Keeper

 

X

 

 

 

If there is no link to the Employee then this allows the details of the registered keeper to be recorded.   Normally the registered keeper is the associated Employee.  

type

vehicleType

Vehicle Type

 

 

 

 

 

The type of Vehicle.    

make

normalizedString

Vehicle Make

 

X

 

 

 

The make of the Vehicle e.g. BMW, Ford, etc.    

model

normalizedString

Vehicle Model

 

X

 

 

 

The model descriptor for the Vehicle e.g. 3 series, Focus    

engineSize

normalizedString

Vehicle Engine Size

 

X

 

 

 

Engine size in cc of the Vehicle e.g. 2000 cc.    

fuelType

normalizedString

Vehicle Fuel Type

 

X

 

 

 

The fuel type for the Vehicle.    

colour

normalizedString

Vehicle Colour

 

X

 

 

 

The colour of the Vehicle.    

registration

normalizedString

Vehicle Registration Number

 

X

 

 

 

The registration number of the Vehicle.    

identificationNumber

normalizedString

Vehicle Identification Number

 

X

 

 

 

The Vehicle identification number.    

dateOfRegistration

date

Vehicle Date of Registration

 

X

 

 

 

Date the Vehicle was registered as new.    

issueDate

date

Vehicle Issue Date

 

X

 

 

 

Date the Vehicle was issued made available for use.    

returnDate

date

Vehicle Return Date

 

X

 

 

 

Date the Vehicle was returned.    

disposalDate

date

Vehicle Disposal Date

 

X

 

 

 

Date the Vehicle was disposed of e.g. sold or scrapped    

disposalReason

normalizedString

Vehicle Disposal Reason

 

X

 

 

 

Textual reason as to why Vehicle was disposed of.    

taxationTypeIndicator

vehicleTaxationTypeIndicator

Vehicle Taxation Type Indicator

 

X

 

 

 

Flag indicating what the taxation of the vehicle is based on – CO2, HP horse power, Mileage, Exempt, other.    

emissions

decimal

Vehicle Emissions

 

X

 

 

 

The emissions associated with the Vehicle, express in CO2, used for tax calculation.    

horsepower

decimal

Vehicle Horse Power

 

X

 

 

 

The associated HP of the Vehicle, used for tax calculation.    

weight

decimal

Vehicle Weight

 

X

 

 

 

Weight of vehicle in SI units KG.    

listPrice

decimal

Vehicle List Price

 

X

 

 

 

List price of the Vehicle.   In Benefit Currency.  

accessoriesPrice

decimal

Vehicle Accessories Price

 

X

 

 

 

Price of any accessories added to the Vehicle.   In Benefit Currency.  

numberOfSeats

normalizedString

Vehicle Number Of Seats

 

X

 

 

 

Number of seats the vehicle has.    

employeeContribution

decimal

Vehicle Employee Contribution

 

X

 

 

 

If an Employee has made a contribution to the purchase cost of the Vehicle it is recorded here.   In Benefit Currency.  

taxablePrice

decimal

Vehicle Taxable Price

 

X

 

 

 

The taxable value of the Vehicle typically List Price + Accessories – Employee Contribution.   In Benefit Currency.  

firstUseDate

date

Vehicle Date of First Use

 

X

 

 

 

The date the vehicle was first used.    

lastTaxDate

date

Vehicle Last Tax Date

 

X

 

 

 

Date any vehicular taxes were last paid.    

nextTaxDate

date

Vehicle Next Tax Date

 

X

 

 

 

Date any vehicular taxes are due to be paid.    

lastServiceDate

date

Vehicle Last Service Date

 

X

 

 

 

Date of last Vehicle service.    

nextServiceDate

date

Vehicle Next Service Date

 

X

 

 

 

Date next Vehicle service is due.    

lastTestDate

date

Vehicle Last Test Date

 

X

 

 

 

Date any Vehicle tests e.g. UK MOT were last done.    

nextTestDate

date

Vehicle Next Test Date

 

X

 

 

 

Date any Vehicle tests e.g. UK MOT are next due.    

supplier

tradingAccount

Vehicle Supplier

 

X

 

 

reference 

Link to the Supplier associated with the Vehicle e.g. leasing company if Vehicle is leased.   See Supplier definition. CRM schema.  

associatedFixedAsset

fixedAsset

Vehicle Associated Fixed Asset

 

X

 

 

reference 

Link to the asset record associated with the Vehicle.   Fixed Assets are defined in the FAM schema  

specialDesignationFlag

boolean

Vehicle Special Designation Flag

 

X

 

 

 

Flag to indicate if Vehicle has any special designations e.g. UK Classic Car designation.   Default = False  

text1

string

Vehicle Text1

 

X

 

 

 

Text/commentary for the Vehicle    

text2

string

Vehicle Text2

 

X

 

 

 

Further text/commentary for the Vehicle.    

mileage

decimal

Vehicle Mileage

 

X

 

 

 

Mileage associated with Vehicle as at Mileage Date, below.    

mileageDate

date

Vehicle Mileage Date

 

X

 

 

 

Date of the mileage figure given above.    

disposalMileage

decimal

Vehicle Disposal Mileage

 

X

 

 

 

Mileage when Vehicle is or was disposed of.    

notes

note*

Vehicle Note

 

X

 

 

child 

Notes associated with a Vehicle.    

Top  

Resource payroll

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Payroll Active Flag

 

 

 

 

 

Flag to indicate if the Payroll is an active one .    

reference

normalizedString

Payroll Reference

X

 

 

 

 

Reference for the Payroll could be the Employee/Payroll number.    

reference2

normalizedString

Payroll Reference2

 

X

 

 

 

Additional reference for the Payroll.    

entryDateTime

dateTime

Payroll Entry Datetime

 

X

 

 

 

Date/time of the Payroll entry.    

entryUser

normalizedString

Payroll Entry User

 

X

 

 

 

The user responsible for the Payroll entry.   The user resource will be defined in the future.  

processDateTime

dateTime

Payroll Process Datetime

 

X

 

 

 

Date/time the Payroll was processed.    

processUser

normalizedString

Payroll Process User

 

X

 

 

 

The user responsible for the Payroll processing.   The user resource will be defined in the future.  

paymentDateTime

dateTime

Payroll Payment Datetime

 

X

 

 

 

Date/time the Payroll Payment was made.    

paymentUser

normalizedString

Payroll Payment User

 

X

 

 

 

The user responsible for the Payroll Payment.   The user resource will be defined in the future.  

operatingCompany

operatingCompany

Payroll OperatingCompany

 

 

 

 

reference 

OperatingCompany associated with the Payroll   See OperatingCompany definition Company where type = Operating Company.  

payrollGroup

payrollGroup

Payroll PayrollGroup

 

X

 

 

parent 

The PayrollGroup this Payroll belongs to.    

employee

employee

Payroll Employee

 

 

 

 

reference 

Employee associated with the Payroll   See Employee definition.  

paymentMethod

payrollPaymentMethod

Payroll Payment Method

 

 

 

 

 

The Payroll payment method.    

payFrequency

payrollPayFrequency

Payroll Pay Frequency

 

X

 

 

 

Frequency with which payments are made there will usually be one Payroll entry per pay frequency.    

taxCodes

taxCode*

Payroll Tax Code

 

X

 

 

association 

Code used during the calculation of taxes for the Payroll.   See TaxCode definition. And/or on the PayrollLine.  

workUnit

payrollWorkUnit

Payroll Work Unit

 

X

 

 

 

Unit associated with the Payroll   And/or on the PayrollLine.  

workQuantity

normalizedString

Payroll Work Quantity

 

X

 

 

 

Quantity of units worked for the Payroll.   And/or on the PayrollLine.  

cumulativeWork

normalizedString

Payroll Cumulative Work

 

X

 

 

 

Cumulative units worked for the Payroll.    

salary

decimal

Payroll Salary

 

X

 

 

 

Salary applicable to the Payroll.   In Payroll currency. And/or on the PayrollLine.  

salaryUnit

payrollSalaryUnit

Payroll Salary Unit

 

X

 

 

 

What the salary is applicable to e.g. per Hour, per Day, etc.   And/or on the PayrollLine.  

payrollCurrency

decimal

Payroll Currency

 

 

 

 

 

Currency of the Payroll    

payrollLines

payrollLine*

Payroll PayrollLine

 

 

 

 

child 

Payroll Line detail e.g. items on the Payroll   See PayrollLine definition.  

lineCount

decimal

Payroll Line Count

 

 

 

 

 

The number of lines on the Payroll.   Should be auto-populated. Used as a cross reference to ensure integrity.  

salaryAmount

decimal

Payroll Salary Amount

 

X

 

 

 

Total amount of salary applicable to the Payroll.   In Payroll currency.  

salaryCumulativeAmount

decimal

Payroll Salary Cumulative Amount

 

X

 

 

 

Total cumulative amount of salary applicable to the Payroll.   In Payroll currency.  

taxAmount

decimal

Payroll Tax Amount

 

X

 

 

 

Total amount of tax applicable to the Payroll.   In Payroll currency.  

taxCumulativeAmount

decimal

Payroll Tax Cumulative Amount

 

X

 

 

 

Total cumulative amount of tax applicable to the Payroll.   In Payroll currency.  

benefitAmount

decimal

Payroll Benefit Amount

 

X

 

 

 

Total amount of benefit applicable to the Payroll.   In Payroll currency.  

benefitCumulativeAmount

decimal

Payroll Benefit Cumulative Amount

 

X

 

 

 

Total cumulative amount of benefit applicable to the Payroll.   In Payroll currency.  

deductionAmountEmployee

decimal

Payroll Deduction Amount Employee

 

X

 

 

 

Total amount of deductions applicable to the Payroll and attributable to the Employee.   In Payroll currency.  

deductionCumulativeAmountEmployee

decimal

Payroll Deduction Cumulative Amount Employee

 

X

 

 

 

Total cumulative amount of deductions applicable to the Payroll.   In Payroll currency.  

deductionAmountEmployer

decimal

Payroll Deduction Amount Employer

 

X

 

 

 

Total amount of deductions applicable to the Payroll and attributable to the Employer.   In Payroll currency.  

deductionCumulativeAmountEmployer

decimal

Payroll Deduction Cumulative Amount Employer

 

X

 

 

 

Total cumulative amount of deductions applicable to the Payroll.   In Payroll currency.  

expenseAmount

decimal

Payroll Expense Amount

 

X

 

 

 

Total Expense amount applicable to the Payroll.   In Payroll currency.  

expenseCumulativeAmount

decimal

Payroll Expense Cumulative Amount

 

X

 

 

 

Total cumulative expense amount applicable to the Payroll.   In Payroll currency.  

netAmount

decimal

Payroll Net Amount

 

X

 

 

 

Net amount applicable to the Payroll e.g. the amount the employee receives, including benefits and expenses, after tax and deductions.   In Payroll currency.  

netCumulativeAmount

decimal

Payroll Net Cumulative Amount

 

X

 

 

 

Cumulative net amount applicable to the Payroll e.g. the amount the employee receives, including benefits and expenses, after tax and deductions.   In Payroll currency.  

text1

string

Payroll Text1

 

X

 

 

 

Text/commentary e.g. special instructions for the Payroll   Header text.  

text2

string

Payroll Text2

 

X

 

 

 

Further text/commentary for the Payroll.   Footer text.  

timesheets

timesheet*

Payroll Timesheet

 

X

 

 

association 

For Payroll entered via a Timesheet, this is a link to the Timesheet headers   See Timesheet definition.  

absences

absence*

Payroll Absence

 

X

 

 

association 

For Payroll entered via an Absence, this is a link to the Absence headers   See Absence definition.  

benefits

benefit*

Payroll Benefit

 

X

 

 

association 

For Payroll entered via a Benefit, this is a link to the Benefit records.   See Benefit definition.  

expenseClaims

expenseClaim*

Payroll Expense Claim

 

X

 

 

association 

For Payroll entered via an Expense, this is a link to the Expense Claim headers   See ExpenseClaim definition.  

payslips

payslip*

Payroll Payslip

 

X

 

 

association 

Payslip associated with the Payroll.   See Payslip definition.  

payments

payment*

Payroll Payment

 

X

 

 

association 

Link to the Payment used to pay the Payroll.   See Payment definition.  

notes

note*

Payroll Note

 

X

 

 

child 

Notes associated with a Payroll.    

Top  

Resource payrollLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PayrollLine Active Flag

 

 

 

 

 

Flag to indicate if the Payroll Line is an active one .    

reference

normalizedString

PayrollLine Reference

X

 

 

 

 

Reference for the Payroll Line.    

reference2

normalizedString

PayrollLine Reference2

 

X

 

 

 

Additional reference for the Payroll Line.    

number

decimal

PayrollLine Number

 

 

 

 

 

The number of the Payroll Line.   For sequencing and ordering of lines.  

type

payrollLineType

PayrollLine Type

 

X

 

 

 

Enumerator indicating the type of Payroll Line.    

name

normalizedString

PayrollLine Name

 

X

 

 

 

Name of the Payroll Line e.g. Base Salary, Income Tax, Car Benefit, Loan Payment Deduction, Expense Reimbursement    

description

normalizedString

PayrollLine Description

 

X

 

 

 

Description of the Payroll Line.    

taxCodes

taxCode*

PayrollLine Tax Code

 

X

 

 

association 

Code used during the calculation of taxes for the Payroll Line.   See TaxCode definition.  

workUnit

payrollLineWorkUnit

PayrollLine Work Unit

 

X

 

 

 

Unit associated with the Payroll Line   And/or on the PayrollLine.  

workQuantity

normalizedString

PayrollLine Work Quantity

 

X

 

 

 

Quantity of units worked for the Payroll Line.    

cumulativeWork

normalizedString

PayrollLine Cumulative Work

 

X

 

 

 

Cumulative units worked for the Payroll Line.    

salary

decimal

PayrollLine Salary

 

X

 

 

 

Salary applicable to the Payroll Line the Salary may be shown on all lines, even though this line is for e.g. tax, deduction, etc.   In Payroll currency.  

salaryUnit

payrollLineSalaryUnit

PayrollLine Salary Unit

 

X

 

 

 

What the salary is applicable to e.g. per Hour, per Day, etc.    

salaryAmount

decimal

PayrollLine Salary Amount

 

X

 

 

 

Total amount of salary applicable to the Payroll Line if Line Type = Salary.   In Payroll currency.  

salaryCumulativeAmount

decimal

PayrollLine Salary Cumulative Amount

 

X

 

 

 

Total cumulative amount of salary applicable to the Payroll Line if Line Type = Salary. Cumulative values are typically per financial year.   In Payroll currency.  

taxAmount

decimal

PayrollLine Tax Amount

 

X

 

 

 

Total amount of tax applicable to the Payroll Line if Line Type = Tax.   In Payroll currency.  

taxCumulativeAmount

decimal

PayrollLine Tax Cumulative Amount

 

X

 

 

 

Total cumulative amount of tax applicable to the Payroll Line if Line Type = Tax.   In Payroll currency.  

benefitAmount

decimal

PayrollLine Benefit Amount

 

X

 

 

 

Total amount of benefit applicable to the Payroll Line if Line Type = Benefit.   In Payroll currency.  

benefitCumulativeAmount

decimal

PayrollLine Benefit Cumulative Amount

 

X

 

 

 

Total cumulative amount of benefit applicable to the Payroll Line if Line Type = Benefit.   In Payroll currency.  

deductionAmountEmployee

decimal

PayrollLine Deduction Amount Employee

 

X

 

 

 

Total amount of deductions applicable to the Payroll Line if Line Type = Deduction and attributable to the Employee.   In Payroll currency.  

deductionCumulativeAmountEmployee

decimal

PayrollLine Deduction Cumulative Amount Employee

 

X

 

 

 

Total cumulative amount of deductions applicable to the Payroll Line if Line Type = Deduction.   In Payroll currency.  

deductionAmountEmployer

decimal

PayrollLine Deduction Amount Employer

 

X

 

 

 

Total amount of deductions applicable to the Payroll Line if Line Type = Deduction and attributable to the Employer.   In Payroll currency.  

deductionCumulativeAmountEmployer

decimal

PayrollLine Deduction Cumulative Amount Employer

 

X

 

 

 

Total cumulative amount of deductions applicable to the Payroll Line if Line Type = Deduction.   In Payroll currency.  

expenseAmount

decimal

PayrollLine Expense Amount

 

X

 

 

 

Expense amount applicable to the Payroll Line if Line Type = Expense.   In Payroll currency.  

expenseCumulativeAmount

decimal

PayrollLine Expense Cumulative Amount

 

X

 

 

 

Cumulative expense amount applicable to the Payroll Line if Line Type = Expense.   In Payroll currency.  

netAmount

decimal

PayrollLine Net Amount

 

X

 

 

 

Net amount applicable to the Payroll Line e.g. the amount the employee receives.   In Payroll currency.  

netCumulativeAmount

decimal

Payroll Net Cumulative Amount

 

X

 

 

 

Cumulative net amount applicable to the Payroll Line e.g. the amount the employee receives.   In Payroll currency.  

text1

string

PayrollLine Text1

 

X

 

 

 

Text/commentary e.g. special instructions for the Payroll Line   Header text.  

text2

string

PayrollLine Text2

 

X

 

 

 

Further text/commentary for the Payroll Line.   Footer text.  

payrollElement

payrollElement

PayrollLine Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to the Payroll Line.   See PayrollElement definition  

financialAccounts

financialAccount*

PayrollLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Payroll Line.   See FinancialAccount definition.  

costCentres

costCentre*

PayrollLine CostCentre

 

X

 

 

association 

 

departments

department*

PayrollLine Department

 

X

 

 

association 

 

timesheetLines

timesheetLine*

PayrollLine TimesheetLine

 

X

 

 

association 

For Payroll entered via a Timesheet, this is a link to the Timesheet Line.   See TimesheetLine definition.  

absenceLines

absenceLine*

PayrollLine AbsenceLine

 

X

 

 

association 

For Payroll entered via an Absence, this is a link to the Absence Line.   See AbsenceLine definition.  

expenseClaimLines

expenseClaimLine*

PayrollLine ExpenseClaimLine

 

X

 

 

association 

For Payroll entered via an Expense, this is a link to the Expense Claim Line.   See ExpenseClaimLine definition.  

payslipLines

payslipLine*

PayrollLine PayslipLine

 

X

 

 

association 

PayslipLine associated with the Payroll Line.   See PayslipLine definition.  

paymentLines

paymentLine*

PayrollLine PaymentLine

 

X

 

 

association 

Link to the PaymentLine used to pay the Payroll Line.   See PaymentLine definition.  

notes

note*

PayrollLine Note

 

X

 

 

child 

Notes associated with a Payroll Line.    

Top  

Resource payrollGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PayrollGroup Active Flag

 

 

 

 

 

Flag to indicate if the Payroll Group is an active one .    

reference

normalizedString

PayrollGroup Reference

 

 

 

 

 

A reference for the Payroll group.    

reference2

normalizedString

PayrollGroup Reference2

 

X

 

 

 

Additional reference for the Payroll Group.    

operatingCompany

operatingCompany

PayrollGroup OperatingCompany

 

 

 

 

reference 

OperatingCompany associated with the Payroll Group   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

PayrollGroup Name

 

 

 

X

 

Name of the Payroll Group.   If this does not exist then a dummy entry should be created, e.g. MAS500 Payrolls  

description

normalizedString

PayrollGroup Description

 

X

 

 

 

A longer description of the Payroll Group.    

payrolls

payroll*

PayrollGroup Payroll

 

X

 

 

child 

Payrolls associated with the Payroll Group.   See Payroll definition.  

notes

note*

PayrollGroup Notes

 

X

 

 

child 

Notes associated with a Payroll Group.    

Top  

Resource payslip

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Payslip Active Flag

 

 

 

 

 

Flag to indicate if the Payslip is an active one .    

reference

normalizedString

Payslip Reference

X

 

 

 

 

Reference for the Payslip could be the Employee/Payslip number.    

reference2

normalizedString

Payslip Reference2

 

X

 

 

 

Additional reference for the Payslip.    

printDateTime

dateTime

Payslip Print Datetime

 

X

 

 

 

Date/time of the Payslip print.    

printUser

normalizedString

Payslip Print User

 

X

 

 

 

The user responsible for the Payslip printing.   The user resource will be defined in the future.  

printReference

normalizedString

Payslip Print Reference

 

X

 

 

 

Additional reference associated with the payslip printing process e.g. spool number.    

emailDateTime

dateTime

Payslip Email Datetime

 

X

 

 

 

Date/time the Payslip was emailed.    

emailUser

normalizedString

Payslip Email User

 

X

 

 

 

The user responsible for emailing the Payslip.   The user resource will be defined in the future.  

emailReference

normalizedString

Payslip Email Reference

 

X

 

 

 

Additional reference associated with the payslip email e.g. delivery tracking number.    

operatingCompany

operatingCompany

Payslip OperatingCompany

 

 

 

 

reference 

OperatingCompany associated with the Payslip   See OperatingCompany definition Company where type = Operating Company.  

employee

employee

Payslip Employee

 

 

 

 

reference 

Employee associated with the Payslip   See Employee definition.  

paymentMethod

payslipPaymentMethod

Payslip Payment Method

 

 

 

 

 

The Payslip payment method.    

payFrequency

payslipPayFrequency

Payslip Pay Frequency

 

X

 

 

 

Frequency with which payments are made there will usually be one Payslip entry per pay frequency.    

taxCodes

taxCode*

Payslip Tax Code

 

X

 

 

association 

Code used during the calculation of taxes for the Payslip.   See TaxCode definition. And/or on the PayslipLine.  

workUnit

payslipWorkUnit

Payslip Work Unit

 

X

 

 

 

Unit associated with the Payslip   And/or on the PayslipLine.  

workQuantity

normalizedString

Payslip Work Quantity

 

X

 

 

 

Quantity of units worked for the Payslip.   And/or on the PayslipLine.  

cumulativeWork

normalizedString

Payslip Cumulative Work

 

X

 

 

 

Cumulative units worked for the Payslip.    

salary

decimal

Payslip Salary

 

X

 

 

 

Salary applicable to the Payslip.   In Payslip currency. And/or on the PayslipLine.  

salaryUnit

payslipSalaryUnit

Payslip Salary Unit

 

X

 

 

 

What the salary is applicable to e.g. per Hour, per Day, etc.   And/or on the PayslipLine.  

payrollCurrency

decimal

Payslip Currency

 

 

 

 

 

Currency of the Payslip    

payrollLines

payslipLine*

Payslip PayslipLine

 

 

 

 

child 

Payslip Line detail e.g. items on the Payslip   See PayslipLine definition.  

lineCount

decimal

Payslip Line Count

 

 

 

 

 

The number of lines on the Payslip.   Should be auto-populated. Used as a cross reference to ensure integrity.  

salaryAmount

decimal

Payslip Salary Amount

 

X

 

 

 

Total amount of salary applicable to the Payslip.   In Payslip currency.  

salaryCumulativeAmount

decimal

Payslip Salary Cumulative Amount

 

X

 

 

 

Total cumulative amount of salary applicable to the Payslip.   In Payslip currency.  

taxAmount

decimal

Payslip Tax Amount

 

X

 

 

 

Total amount of tax applicable to the Payslip.   In Payslip currency.  

taxCumulativeAmount

decimal

Payslip Tax Cumulative Amount

 

X

 

 

 

Total cumulative amount of tax applicable to the Payslip.   In Payslip currency.  

benefitAmount

decimal

Payslip Benefit Amount

 

X

 

 

 

Total amount of benefit applicable to the Payslip.   In Payslip currency.  

benefitCumulativeAmount

decimal

Payslip Benefit Cumulative Amount

 

X

 

 

 

Total cumulative amount of benefit applicable to the Payslip.   In Payslip currency.  

deductionAmount

decimal

Payslip Deduction Amount

 

X

 

 

 

Total amount of deductions applicable to the Payslip.   In Payslip currency.  

deductionCumulativeAmount

decimal

Payslip Deduction Cumulative Amount

 

X

 

 

 

Total cumulative amount of deductions applicable to the Payslip.   In Payslip currency.  

expenseAmount

decimal

Payslip Expense Amount

 

X

 

 

 

Total Expense amount applicable to the Payslip.   In Payslip currency.  

expenseCumulativeAmount

decimal

Payslip Expense Cumulative Amount

 

X

 

 

 

Total cumulative expense amount applicable to the Payslip.   In Payslip currency.  

netAmount

decimal

Payslip Net Amount

 

X

 

 

 

Net amount applicable to the Payslip e.g. the amount the employee receives, including benefits and expenses, after tax and deductions.   In Payslip currency.  

netCumulativeAmount

decimal

Payslip Net Cumulative Amount

 

X

 

 

 

Cumulative net amount applicable to the Payslip e.g. the amount the employee receives, including benefits and expenses, after tax and deductions.   In Payslip currency.  

text1

string

Payslip Text1

 

X

 

 

 

Text/commentary e.g. special instructions for the Payslip   Header text.  

text2

string

Payslip Text2

 

X

 

 

 

Further text/commentary for the Payslip.   Footer text.  

timesheets

timesheet*

Payslip Timesheet

 

X

 

 

association 

For Payslip entered via a Timesheet, this is a link to the Timesheet headers   See Timesheet definition.  

absences

absence*

Payslip Absence

 

X

 

 

association 

For Payslip entered via an Absence, this is a link to the Absence headers   See Absence definition.  

benefits

benefit*

Payslip Benefit

 

X

 

 

association 

For Payslip entered via a Benefit, this is a link to the Benefit records.   See Benefit definition.  

expenseClaims

expenseClaim*

Payslip Expense Claim

 

X

 

 

association 

For Payslip entered via an Expense, this is a link to the Expense Claim headers   See ExpenseClaim definition.  

payments

payment*

Payslip Payment

 

X

 

 

association 

Link to the Payment used to pay the Payslip.   See Payment definition.  

notes

note*

Payslip Note

 

X

 

 

child 

Notes associated with a Payslip.    

Top  

Resource payslipLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PayslipLine Active Flag

 

 

 

 

 

Flag to indicate if the Payslip Line is an active one .    

reference

normalizedString

PayslipLine Reference

X

 

 

 

 

Reference for the Payslip Line.    

reference2

normalizedString

PayslipLine Reference2

 

X

 

 

 

Additional reference for the Payslip Line.    

number

decimal

PayslipLine Number

 

 

 

 

 

The number of the Payslip Line.   For sequencing and ordering of lines.  

type

payslipLineType

PayslipLine Type

 

X

 

 

 

Enumerator indicating the type of Payslip Line.    

name

normalizedString

PayslipLine Name

 

X

 

 

 

Name of the Payslip Line e.g. Base Salary, Income Tax, Car Benefit, Loan Payment Deduction, Expense Reimbursement    

description

normalizedString

PayslipLine Description

 

X

 

 

 

Description of the Payslip Line.    

taxCodes

taxCode*

PayslipLine Tax Code

 

X

 

 

association 

Code used during the calculation of taxes for the Payslip Line.   See TaxCode definition.  

workUnit

payslipLineWorkUnit

PayslipLine Work Unit

 

X

 

 

 

Unit associated with the Payslip Line   And/or on the PayslipLine.  

workQuantity

normalizedString

PayslipLine Work Quantity

 

X

 

 

 

Quantity of units worked for the Payslip Line.    

cumulativeWork

normalizedString

PayslipLine Cumulative Work

 

X

 

 

 

Cumulative units worked for the Payslip Line.    

salary

decimal

PayslipLine Salary

 

X

 

 

 

Salary applicable to the Payslip Line.   In Payroll currency.  

salaryUnit

payslipLineSalaryUnit

PayslipLine Salary Unit

 

X

 

 

 

What the salary is applicable to e.g. per Hour, per Day, etc.    

salaryAmount

decimal

PayslipLine Salary Amount

 

X

 

 

 

Total amount of salary applicable to the Payslip Line if Line Type = Salary.   In Payroll currency.  

salaryCumulativeAmount

decimal

PayslipLine Salary Cumulative Amount

 

X

 

 

 

Total cumulative amount of salary applicable to the Payslip Line if Line Type = Salary. Cumulative values are typically per financial year.   In Payroll currency.  

taxAmount

decimal

PayslipLine Tax Amount

 

X

 

 

 

Total amount of tax applicable to the Payslip Line if Line Type = Tax.   In Payroll currency.  

taxCumulativeAmount

decimal

PayslipLine Tax Cumulative Amount

 

X

 

 

 

Total cumulative amount of tax applicable to the Payslip Line if Line Type = Tax.   In Payroll currency.  

benefitAmount

decimal

PayslipLine Benefit Amount

 

X

 

 

 

Total amount of benefit applicable to the Payslip Line if Line Type = Benefit.   In Payroll currency.  

benefitCumulativeAmount

decimal

PayslipLine Benefit Cumulative Amount

 

X

 

 

 

Total cumulative amount of benefit applicable to the Payslip Line if Line Type = Benefit.   In Payroll currency.  

deductionAmount

decimal

PayslipLine Deduction Amount

 

X

 

 

 

Total amount of deductions applicable to the Payslip Line if Line Type = Deduction.   In Payroll currency.  

deductionCumulativeAmount

decimal

PayslipLine Deduction Cumulative Amount

 

X

 

 

 

Total cumulative amount of deductions applicable to the Payslip Line if Line Type = Deduction.   In Payroll currency.  

expenseAmount

decimal

PayslipLine Expense Amount

 

X

 

 

 

Expense amount applicable to the Payslip Line if Line Type = Expense.   In Payroll currency.  

expenseCumulativeAmount

decimal

PayslipLine Expense Cumulative Amount

 

X

 

 

 

Cumulative expense amount applicable to the Payslip Line if Line Type = Expense.   In Payroll currency.  

netAmount

decimal

PayslipLine Net Amount

 

X

 

 

 

Net amount applicable to the Payslip Line e.g. the amount the employee receives.   In Payroll currency.  

netCumulativeAmount

decimal

Payroll Net Cumulative Amount

 

X

 

 

 

Cumulative net amount applicable to the Payslip Line e.g. the amount the employee receives.   In Payroll currency.  

text1

string

PayslipLine Text1

 

X

 

 

 

Text/commentary e.g. special instructions for the Payslip Line   Header text.  

text2

string

PayslipLine Text2

 

X

 

 

 

Further text/commentary for the Payslip Line.   Footer text.  

payrollElement

payrollElement

PayslipLine Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to the Payslip Line.   See PayrollElement definition  

financialAccounts

financialAccount*

PayslipLine FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Payslip Line.   See FinancialAccount definition.  

costCentres

costCentre*

PayslipLine CostCentre

 

X

 

 

association 

 

departments

department*

PayslipLine Department

 

X

 

 

association 

 

timesheetLines

timesheetLine*

PayslipLine TimesheetLine

 

X

 

 

association 

For Payroll entered via a Timesheet, this is a link to the Timesheet Line.   See TimesheetLine definition.  

absenceLines

absenceLine*

PayslipLine AbsenceLine

 

X

 

 

association 

For Payroll entered via an Absence, this is a link to the Absence Line.   See AbsenceLine definition.  

expenseClaimLines

expenseClaimLine*

PayslipLine ExpenseClaimLine

 

X

 

 

association 

For Payroll entered via an Expense, this is a link to the Expense Claim Line.   See ExpenseClaimLine definition.  

notes

note*

PayslipLine Note

 

X

 

 

child 

Notes associated with a Payslip Line.    

Top  

Resource objective

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Objective Active Flag

 

 

 

 

 

Flag to indicate if the Objective is an active Objective .    

operatingCompany

operatingCompany

Objective OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Objective.   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

Objective Name

 

X

 

X

 

Name for the Objective as used by the Operating Company e.g. Sage UK Objective Index.    

reference

normalizedString

Objective Reference

X

 

 

 

 

Reference for the Objective e.g. BI 1.    

reference2

normalizedString

Objective Reference2

 

X

 

 

 

Additional reference for the Objective.    

status

objectiveStatus

Objective Status

 

X

 

 

 

Status of the Objective.    

type

normalizedString

Objective Type

 

 

 

 

 

The Objective type.    

period

normalizedString

Objective Period

 

X

 

 

 

The period e.g. year applicable to the Objective.    

positions

position*

Objective Positions

 

X

 

 

association 

The Positions associated with the Objective.   See Objective definition.  

employee

employee

Objective Employee

 

X

 

 

reference 

A link to the Employee associated with this Objective see Status above.   See Employee definition.  

settingEmployee

employee

Objective Setting Employee

 

X

 

 

reference 

A link to the Employee who set the Objective.   See Employee definition.  

date

date

Objective Date

 

X

 

 

 

The date the Objectives were set.    

startDate

date

Objective Start Date

 

X

 

 

 

The date the Objectives start.    

endDate

date

Objective End Date

 

X

 

 

 

The date the Objectives end.    

reviewingEmployee

employee

Objective Reviewing Employee

 

X

 

 

reference 

A link to the Employee who reviewed the Objective if necessary.   See Employee definition.  

reviewDate

date

Objective Review Date

 

X

 

 

 

The date the Objective was reviewed.    

competencies

competency*

Objective Competency

 

X

 

 

association 

A link to any Competencies associated with the Objective if any.   See Competency definition.  

training

training*

Objective Training

 

X

 

 

association 

Link to Training required to fulfill an Objective.   See Training definition.  

appraisalFrequency

objectiveAppraisalFrequency

Objective Appraisal Frequency

 

X

 

 

 

The frequency with which Appraisals are done against the Objective.    

appraisals

appraisal*

Objective Appraisal

 

X

 

 

association 

Link to any Appraisals conducted in response to the Objectives.   See Appraisal definition.  

text1

string

Objective Text1

 

X

 

 

 

Textual information associated with the Objective.    

text2

string

Objective Text2

 

X

 

 

 

Textual information associated with the Objective.    

notes

note*

Objective Note

 

X

 

 

child 

Notes associated with an Objective.    

Top  

Resource appraisal

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Appraisal Active Flag

 

 

 

 

 

Flag to indicate if the Appraisal is an active one .    

reference

normalizedString

Appraisal Reference

X

 

 

 

 

Reference associated with the Appraisal.    

reference2

normalizedString

AppraisalReference2

 

X

 

 

 

Another reference associated with the Appraisal.    

operatingCompany

operatingCompany

Appraisal OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Appraisal.   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

Appraisal Name

 

 

 

X

 

The name of the Appraisal e.g. FY08 Review.    

description

normalizedString

Appraisal Description

 

X

 

 

 

Textual description of the Appraisal.    

status

appraisalStatus

Appraisal Status

 

X

 

 

 

Status of the Appraisal.    

period

normalizedString

Appraisal Period

 

X

 

 

 

The period e.g. year applicable to the Appraisal.    

employee

employee

Appraisal Employee

 

X

 

 

reference 

A link to the Employee involved in the Appraisal.   See Employee definition.  

employeeComments

string

Appraisal Employee Comments

 

X

 

 

 

Comments made by the Employee in connection with the Appraisal.    

appraiserEmployee

employee

Appraisal Appraiser Employee

 

X

 

 

reference 

A link to the Employee who performed the Appraisal.   See Employee definition.  

appraiserComments

string

Appraisal Appraiser Comments

 

X

 

 

 

Comments made by the Appraiser in connection with the Appraisal.    

date

date

Appraisal Date

 

X

 

 

 

The date of the appraisal    

reviewerEmployee

employee

Appraisal Reviewer Employee

 

X

 

 

reference 

A link to the Employee who reviewed the Appraisal if necessary.   See Employee definition.  

reviewerComments

string

Appraisal Reviewer Comments

 

X

 

 

 

Comments made by the Reviewer in connection with the Appraisal.    

reviewDate

date

Appraisal Review Date

 

X

 

 

 

The date the Appraisal was reviewed.    

approvalEmployee

employee

Appraisal Approval Employee

 

X

 

 

reference 

A link to the Employee who will give final approval to the Appraisal – typically HR.   See Employee definition.  

approvalComments

string

Appraisal Approval Comments

 

X

 

 

 

Comments made by the final approver in connection with the Appraisal.    

approvalDate

date

Appraisal Final Approval Date

 

X

 

 

 

The date the Appraisal was consumed.    

positionsAssessed

position*

Appraisal Positions Assessed

 

X

 

 

association 

The Positions associated with the Employee involved in the Appraisal i.e. the Employees current level in the Organization   See Position definition.  

newPositions

position*

Appraisal New Position

 

X

 

 

association 

If the Appraisal resulted in a new Position for the Employee, then this is a link to the new Position.   See Position definition.  

employmentAssessed

employment

Appraisal Employment Assessed

 

X

 

 

reference 

The Employment contract that is framing the appraisal.   See Employment definition.  

newEmployment

employment

Appraisal New Employment

 

X

 

 

reference 

If the Appraisal resulted in a new Position for the Employee, then typically there will be a new terms of Employment. This is a link to the new Employment.   See Employment definition.  

frequency

appraisalFrequency

Appraisal Frequency

 

X

 

 

 

The Appraisal type e.g. Final, Monthly, And Interim.    

type

appraisalType

Appraisal Type

 

X

 

 

 

The type of Appraisal being done.    

method

normalizedString

Appraisal Method

 

X

 

 

 

The method used during the appraisal process meeting, telephone, etc.    

overallScoreNumber

decimal

Appraisal Overall Score Number

 

X

 

 

 

The overall score of the Appraisal.   Could also be a decimal scale e.g. 0 - 100 percent  

scoreNumberMaximum

decimal

Appraisal Score Number Maximum

 

X

 

 

 

The maximum possible score available for the Appraisal.   E.g. if Overall Score is 4 then this could be 5, indicating 4 out of 5.  

overallScoreText

normalizedString

Appraisal Overall Score Text

 

X

 

 

 

The overall score of the Appraisal in text format.    

competenciesAssessed

competency*

Appraisal Competencies Assessed

 

X

 

 

association 

A link to the Competencies assessed as a part of the Appraisal.   See Competency definition.  

competenciesAchieved

competency*

Appraisal Competencies Achieved

 

X

 

 

association 

A link to the new Competencies demonstrated as a result of the Appraisal.   See Competency definition.  

objectivesAssessed

objective*

Appraisal Objectives Assessed

 

X

 

 

association 

The Objectives set for the Employee that are the focus of the Appraisal.   See Objective definition  

newObjectives

objective*

Appraisal New Objective

 

X

 

 

association 

New Objectives set as a result of the Appraisal typically feed into next Appraisal.   See Objective definition  

trainingAssessed

training*

Appraisal Training Assessed

 

X

 

 

association 

Link to Training required to fulfill an Objective.   See Training definition.  

trainingAchieved

trainingEvent*

Appraisal Training Achieved

 

X

 

 

association 

Link to Training Events achieved attended to fulfill an Objective.   See Training Event definition. Training Events are individual instances of Training.  

payrollLines

payrollLine*

Appraisal Payroll Lines

 

X

 

 

association 

Link to one or more Payroll Lines that may result from the Appraisal e.g. if a bonus payment was made.   See Payroll Line definition.  

passFlag

boolean

Appraisal Pass Flag

 

X

 

 

 

A Boolean value used to describe if the Appraisal resulted in a Pass or a Fail   Pass = True Fail = False  

text1

string

Appraisal Text1

 

X

 

 

 

Textual information associated with the Appraisal.    

text2

string

Appraisal Text2

 

X

 

 

 

Textual information associated with the Appraisal.    

notes

note*

Appraisal Note

 

X

 

 

child 

Notes associated with the Appraisal    

Top  

Resource disciplinary

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Disciplinary Active Flag

 

 

 

 

 

Flag to indicate if the Disciplinary is an active one .    

reference

normalizedString

Disciplinary Reference

X

 

 

 

 

Reference associated with the Disciplinary.    

reference2

normalizedString

Disciplinary Reference2

 

X

 

 

 

Another reference associated with the Disciplinary.    

name

normalizedString

Disciplinary Name

 

X

 

X

 

The name of the Disciplinary.    

operatingCompany

operatingCompany

Disciplinary OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Disciplinary.   See OperatingCompany definition Company where type = Operating Company.  

stage

disciplinaryStage

Disciplinary Stage

 

 

 

 

 

The name of the Disciplinary e.g. Formal Warning, Dismissal, etc.    

type

normalizedString

Disciplinary Type

 

X

 

 

 

The type of Disciplinary e.g. gross misconduct    

version

normalizedString

Disciplinary Version

 

X

 

 

 

A version or number associated with the Disciplinary e.g. 1st, 2nd etc    

description

normalizedString

Disciplinary Description

 

X

 

 

 

Textual description of the Disciplinary.    

status

disciplinaryStatus

Disciplinary Status

 

X

 

 

 

Status of the Disciplinary.    

employee

employee

Disciplinary Employee

 

X

 

 

reference 

A link to the Employee involved in the Disciplinary.   See Employee definition.  

performingEmployee

employee

Disciplinary Performing Employee

 

X

 

 

reference 

A link to the Employee who performed the Disciplinary.   See Employee definition.  

witnessingEmployee

employee

Disciplinary Witnessing Employee

 

X

 

 

reference 

A link to the Employee who witnessed the Disciplinary if any.   See Employee definition.  

date

date

Disciplinary Date

 

X

 

 

 

The date of the Disciplinary    

reviewingEmployee

employee

Disciplinary Reviewing Employee

 

X

 

 

reference 

A link to the Employee who reviewed the Disciplinary if necessary.   See Employee definition.  

reviewDate

date

Disciplinary Review Date

 

X

 

 

 

The date the Disciplinary was reviewed.    

approvingEmployee

employee

Disciplinary Approving Employee

 

X

 

 

reference 

A link to the Employee who will give final approval to the Disciplinary – typically HR.   See Employee definition.  

approvalDate

date

Disciplinary Approval Date

 

X

 

 

 

The date the Disciplinary was finally approved.    

method

normalizedString

Disciplinary Method

 

X

 

 

 

The method used during the Disciplinary process meeting, telephone, etc.    

expiry

date

Disciplinary Expiry Date

 

X

 

 

 

Date of expiry of the Disciplinary, if applicable.    

appealDate

date

Disciplinary Appeal Date

 

X

 

 

 

The date of the Disciplinary Appeal if made.    

appealReviewingEmployee

employee

Disciplinary Appeal Reviewing Employee

 

X

 

 

reference 

A link to the Employee who reviewed the Disciplinary Appeal if necessary.   See Employee definition.  

appealWitnessingEmployee

employee

Disciplinary Appeal Witnessing Employee

 

X

 

 

reference 

A link to the Employee who witnessed the Disciplinary Appeal if any.   See Employee definition.  

appealResult

string

Disciplinary Appeal Result

 

X

 

 

 

The result of the appeal.    

dismissalFlag

boolean

Disciplinary Dismissal Flag

 

X

 

 

 

Flag to indicate if this Disciplinary has resulted in Employee dismissal.    

employment

employment

Disciplinary Employment

 

X

 

 

reference 

The Employment that is associated with the Disciplinary.   See Employment definition.  

incidents

incident*

Disciplinary Incident

 

X

 

 

association 

Link to any Incidents association with the Disciplinary.   See Incident definition.  

text1

string

Disciplinary Text1

 

X

 

 

 

Textual information associated with the Disciplinary.    

text2

string

Disciplinary Text2

 

X

 

 

 

Textual information associated with the Disciplinary.    

notes

note*

Disciplinary Note

 

X

 

 

child 

Notes associated with the Disciplinary    

Top  

Resource incident

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Incident Active Flag

 

 

 

 

 

Flag to indicate if the Incident is an active one .    

reference

normalizedString

Incident Reference

X

 

 

 

 

Reference associated with the Incident.    

reference2

normalizedString

Incident Reference2

 

X

 

 

 

Another reference associated with the Incident.    

operatingCompany

operatingCompany

Incident OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Incident.   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

Incident Name

 

 

 

X

 

The name of the Incident e.g. FY08 Review.    

description

normalizedString

Incident Description

 

X

 

 

 

Textual description of the Incident.    

type

incidentType

Incident Type

 

X

 

 

 

The Incident type e.g. accident at work, theft of a computer or damage to a vehicle.    

vehicle

vehicle

Incident Vehicle

 

X

 

 

reference 

Link to any Vehicle involved in the Incident, if applicable.   See Vehicle definition.  

associatedFixedAsset

fixedAsset

Incident Associated Fixed Asset

 

X

 

 

reference 

Where an Incident involves an Asset e.g. vehicle, computer then this is a link to the asset record.   Fixed Assets are defined in the FAM schema  

status

incidentStatus

Incident Status

 

X

 

 

 

Status of the Incident.    

insuranceStatus

normalizedString

Incident Insurance Status

 

X

 

 

 

Status of the Incident if insurance is involved e.g. Claimed, Paid, etc.    

insuranceText

string

Incident Insurance Text

 

X

 

 

 

Text field associated with the Incident to hold insurance details e.g. claim number.    

employees

employee*

Incident Employee

 

X

 

 

association 

A link to the Employee involved in the Incident.   See Employee definition.  

reportingEmployee

employee

Incident Reporting Employee

 

X

 

 

reference 

A link to the Employee who reported the Incident.   See Employee definition.  

date

date

Incident Date

 

X

 

 

 

The date of the Incident    

reviewingEmployee

employee

Incident Reviewing Employee

 

X

 

 

reference 

A link to the Employee who reviewed the Incident if necessary.   See Employee definition.  

reviewDate

date

Incident Review Date

 

X

 

 

 

The date the Incident was reviewed.    

filingEmployee

employee

Incident Filing Employee

 

X

 

 

reference 

A link to the Employee who will file the Incident – typically HR.   See Employee definition.  

filingDate

date

Incident Filing Date

 

X

 

 

 

The date the Incident was consumed.    

workplace

workplace

Incident Workplace

 

X

 

 

reference 

The Workplace associated with the Employee involved in the Incident i.e. the Employees current workplace   See Workplace definition.  

employment

employment

Incident Employment

 

X

 

 

reference 

The Employment that is associated with the Incident.   See Employment definition.  

text1

string

Incident Text1

 

X

 

 

 

Textual information associated with the Incident e.g. supporting information.    

text2

string

Incident Text2

 

X

 

 

 

Textual information associated with the Incident e.g. follow up actions.    

disciplinaries

disciplinary*

Incident Disciplinaries

 

X

 

 

association 

If the Incident has resulted in any Disciplinary action then this is the link.   See Disciplinary definition.  

notes

note*

Incident Note

 

X

 

 

child 

Notes associated with the Incident    

Top  

Resource training

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Training Active Flag

 

 

 

 

 

Flag to indicate if the Training is an active one .    

reference

normalizedString

Training Reference

X

 

 

 

 

Reference associated with the Training.    

reference2

normalizedString

Training Reference2

 

X

 

 

 

Another reference associated with the Training.    

operatingCompany

operatingCompany

Training OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Training.   See OperatingCompany definition Company where type = Operating Company.  

type

normalizedString

Training Type

 

X

 

 

 

The type of training e.g. Managerial, Sales, etc    

category

trainingCategory

Training Category

 

 

 

 

 

The type of the Training e.g. internal or external    

trainingGroups

trainingGroup*

Training Group

 

X

 

 

association 

A link to the Training Group associated with this Training.   See Training Group definition.  

description

normalizedString

Training Description

 

X

 

 

 

Textual description of the Training.    

frequency

normalizedString

Training Frequency

 

X

 

 

 

Frequency with which the training occurs e.g. weekly, monthly, annually.    

duration

normalizedString

Training Duration

 

X

 

 

 

Typical duration of the Training    

sessions

decimal

Training Sessions

 

X

 

 

 

Number of sessions that make up the Training.   Each Session could be represented by a different Training Event.  

sessionUnit

decimal

Training Session Unit

 

X

 

 

 

The unit associated with the Session number.    

trainingEvents

trainingEvent*

Training Event

 

X

 

 

association 

Link to individual instances of the Training – Training Events.   See Training Event definition. Training is typically delivered several times in different events with different employees on each.  

deliveryMethod

trainingDeliveryMethod

Training Delivery Method

 

X

 

 

 

The method used during the Training process classroom, research, job shadow, etc.    

preRequisites

training*

Training Pre-Requisites

 

X

 

 

association 

A link to other Training that is a pre-requisite for attending this Training.   See Training definition.  

minimumAttendees

decimal

Training Minimum Attendees

 

X

 

 

 

The number of attendees Employees or External Delegates that must be on the Training before it can typically go-ahead.    

maximumAttendees

decimal

Training Maximum Attendees

 

X

 

 

 

The maximum number of attendees Employees or External Delegates that can attend Training.    

optimumAttendees

decimal

Training Optimum Attendees

 

X

 

 

 

The number of attendees Employees or External Delegates that ideally would be on the Training before it would typically go-ahead.    

text1

string

Training Text1

 

X

 

 

 

Textual information associated with the Training.    

text2

string

Training Text2

 

X

 

 

 

Textual information associated with the Training.    

workplace

workplace

Training Workplace

 

X

 

 

reference 

Default Location if used where the Training is to be delivered.   See Workplace definition.  

supplier

tradingAccount

Training Supplier

 

X

 

 

reference 

Link to the default Supplier associated with the Training e.g. training service provider.   See Supplier definition. CRM schema.  

trainerEmployees

employee*

Training Trainer Employee

 

X

 

 

association 

For internal training A link to the Employee who will normally deliver the Training.   See Employee definition.  

administratingEmployees

employee*

Training Administrating Employee

 

X

 

 

association 

A link to the Employee who administers the Training.   See Employee definition.  

associatedCompetencies

competency*

Training Associated Competencies

 

X

 

 

association 

Link to the Competency that may be associated with this Training.   See Competency definition.  

cost

decimal

Training Cost

 

X

 

 

 

Typical Cost budgeted of the Training.    

cumulativeCost

decimal

Training Cumulative Cost

 

X

 

 

 

Actual cost of all instances Training Events of the Training.    

clawbackFlag

boolean

Training Clawback Flag

 

X

 

 

 

A flag to indicate the Training costs may be clawed back reclaimed by an Employer from an Employee e.g. in the event of an Employee leaving.   Default = False  

clawbackPeriod

normalizedString

Training Clawback Period

 

X

 

 

 

The period within which costs may be reclaimed if a claw back clause was invoked – on clawback unit see below   e.g. 12 months  

clawbackPeriodUnit

trainingClawbackPeriodUnit

Training Clawback Period Unit

 

X

 

 

 

Time unit of measure applicable to the clawback period typically weeks or months.    

clawbackPeriodPercentage

decimal

Training Clawback Period Percentage

 

X

 

 

 

Percentage of Training Event cost that would be reclaimed e.g. by the Employer if a claw back clause is invoked.   e.g. 100 percent  

notes

note*

Training Note

 

X

 

 

child 

Notes associated with the Training    

Top  

Resource trainingEvent

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

TrainingEvent Active Flag

 

 

 

 

 

Flag to indicate if the TrainingEvent is an active one .    

reference

normalizedString

TrainingEvent Reference

X

 

 

 

 

Reference associated with the TrainingEvent.    

reference2

normalizedString

TrainingEvent Reference2

 

X

 

 

 

Another reference associated with the TrainingEvent.    

operatingCompany

operatingCompany

TrainingEvent OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Training Event.   See OperatingCompany definition Company where type = Operating Company.  

description

normalizedString

TrainingEvent Description

 

X

 

 

 

Textual description of the TrainingEvent.    

status

trainingEventStatus

TrainingEvent Status

 

 

 

 

 

Status of the TrainingEvent.    

duration

normalizedString

TrainingEvent Duration

 

X

 

 

 

Actual/planned duration of the Training Event.    

minimumAttendees

decimal

TrainingEvent Minimum Attendees

 

X

 

 

 

The number of attendees Employees or External Delegates that must be on the Training Event before it can typically go-ahead.    

maximumAttendees

decimal

TrainingEvent Maximum Attendees

 

X

 

 

 

The maximum number of attendees Employees or External Delegates that can attend the Training Event.    

attendeeNumber

decimal

TrainingEvent Attendee Number

 

X

 

 

 

Planned or actual number of attendees on the Training Event.    

trainingRegisters

trainingRegister*

TrainingEvent Training Registers

 

X

 

 

association 

A link to the Training Registers – a list of attendees on the Training Event.   See TrainingRegister definition.  

dateFrom

date

TrainingEvent Date From

 

X

 

 

 

The date planned or actual of the TrainingEvent    

dateTo

date

TrainingEvent Date To

 

X

 

 

 

The date planned or actual of the TrainingEvent    

deliveryMethod

trainingEventDeliveryMethod

TrainingEvent Delivery Method

 

X

 

 

 

The method used during the TrainingEvent process classroom, research, job shadow, etc.    

prerequisites

training*

TrainingEvent Pre-Requisites

 

X

 

 

association 

A link to other Training that is a pre-requisite for attending this Training.   See Training definition.  

text1

string

TrainingEvent Text1

 

X

 

 

 

Textual information associated with the TrainingEvent.    

text2

string

TrainingEvent Text2

 

X

 

 

 

Textual information associated with the TrainingEvent.    

workplace

workplace

TrainingEvent Workplace

 

X

 

 

reference 

Link to the Location if used where the TrainingEvent was/is to be delivered.   See Workplace definition.  

supplier

tradingAccount

TrainingEvent Supplier

 

X

 

 

reference 

Link to the Supplier associated with the TrainingEvent e.g. TrainingEvent service provider.   See Supplier definition. CRM schema.  

trainerEmployees

employee*

TrainingEvent Trainer Employee

 

X

 

 

association 

For internal TrainingEvent A link to the Employee who delivered/will deliver the TrainingEvent.   See Employee definition.  

associatedCompetencies

competency*

TrainingEvent Associated Competency

 

X

 

 

association 

Link to the Competency that may be associated with this TrainingEvent.   See Competency definition.  

actualCost

decimal

TrainingEvent Actual Cost

 

X

 

 

 

Actual if delivered cost of the Training Event.    

budgetCost

decimal

TrainingEvent Budget Cost

 

X

 

 

 

Budgeted if planned cost of the Training Event.    

clawbackFlag

boolean

TrainingEvent Clawback Flag

 

X

 

 

 

A flag to indicate if the TrainingEvent costs may be clawed back reclaimed by an Employer from an Employee e.g. in the event of an Employee leaving.   Default = False  

clawbackDate

date

Training Clawback Date

 

X

 

 

 

The date within which costs may be reclaimed if a claw back clause was invoked.   E.g. if Clawback Period from Training is 12 months, this date would be 12 months from the Training Event end-date.  

clawbackPercentage

decimal

Training Clawback Percentage

 

X

 

 

 

Percentage of Training Event cost that would be reclaimed e.g. by the Employer if a claw back clause is invoked.    

clawbackAmount

decimal

Training Clawback Amount

 

X

 

 

 

Amount that could be reclaimed from an Employee if a claw back clause is invoked.    

notes

note*

TrainingEvent Note

 

X

 

 

child 

Notes associated with the TrainingEvent    

Top  

Resource trainingRegister

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

TrainingRegister Active Flag

 

 

 

 

 

Flag to indicate if the Training Register is an active one .    

reference

normalizedString

TrainingRegister Reference

X

 

 

 

 

Reference associated with the Training Register.    

reference2

normalizedString

TrainingRegister Reference2

 

X

 

 

 

Another reference associated with the Training Register.    

operatingCompany

operatingCompany

TrainingRegister OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Training Register.   See OperatingCompany definition Company where type = Operating Company.  

trainingEvents

trainingEvent*

TrainingRegister Training Events

 

X

 

 

association 

A link to the specific TrainingEvent this Training Register is an entry for. There may be multiple events.   See TrainingEvent definition.  

status

trainingRegisterStatus

TrainingRegister Status

 

 

 

 

 

Status of the Training Register.    

employees

employee*

TrainingRegister Employee

 

X

 

 

association 

A link to the Employee involved in the Training Register.   See Employee definition.  

externalDelegates

contact*

TrainingRegister External Delegate

 

X

 

 

association 

A link to any external delegates non-Employees that may be involved in the Training Register.   See Contact definition. Contacts are defined in the CRM-ERP schema.  

dateRequested

date

TrainingRegister Date Requested

 

X

 

 

 

The date the Training Register entry was requested.    

dateConfirmed

date

TrainingRegister Date Confirmed

 

X

 

 

 

The date the Training Register entry was confirmed.    

reason

normalizedString

TrainingRegister Reason

 

X

 

 

 

Reason as to why the attendee is on the Training Register.    

source

normalizedString

TrainingRegister Source

 

X

 

 

 

Source of the Training Register entry e.g. Objective, Appraisal, Employee request, Manager request, etc    

text1

string

TrainingRegister Text1

 

X

 

 

 

Textual information associated with the Training Register.    

text2

string

TrainingRegister Text2

 

X

 

 

 

Textual information associated with the Training Register.    

prerequisiteRegisters

trainingRegister*

TrainingRegister Pre-RequisiteRegisters

 

X

 

 

association 

A link to Training Register that show the attendee has covered the pre-requisites for attending this Training.   See TrainingRegister definition.  

passFlag

boolean

TrainingRegister Pass Flag

 

X

 

 

 

A Boolean value used to describe if attendance on the Training resulted in a Pass or a Fail   Pass = True Fail = False  

overallScoreNumber

decimal

TrainingRegister Overall Score Number

 

X

 

 

 

The overall score of the TrainingRegister.   Could also be a decimal scale e.g. 0 - 100 percent  

scoreNumberMaximum

decimal

TrainingRegister Score Number Maximum

 

X

 

 

 

The maximum possible score available for the TrainingRegister.   E.g. if Overall Score is 4 then this could be 5, indicating 4 out of 5.  

overallScoreText

normalizedString

TrainingRegister Overall Score Text

 

X

 

 

 

The overall score of the TrainingRegister in text format.    

competenciesAchieved

competency*

TrainingRegister Competencies Achieved

 

X

 

 

association 

Link to the Competencys that was achieved as part of this Training Register.   See Competency definition.  

evidenceProvided

string

TrainingRegister Evidence Provided

 

X

 

 

 

Textual information associated with the evidence given as confirmation that the training was successful..    

actualCost

decimal

TrainingRegister Actual Cost

 

X

 

 

 

Actual e.g. to this Employee cost of the Training Register.    

absenceLine

absenceLine

TrainingRegister AbsenceLine

 

X

 

 

reference 

Link to any associated Absence Lines. Absence of type study may be associated with attendance at the training.   See AbsenceLine definition.  

notes

note*

TrainingRegister Note

 

X

 

 

child 

Notes associated with the Training Register    

Top  

Resource trainingGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

TrainingGroup Active Flag

 

 

 

 

 

Flag to indicate if the Training Group is an active one.    

reference

normalizedString

TrainingGroup Reference

 

 

 

 

 

A reference for the Training Group.    

reference2

normalizedString

TrainingGroup Reference2

 

X

 

 

 

Additional reference for the Training Group.    

operatingCompany

operatingCompany

TrainingGroup OperatingCompany

 

X

 

 

reference 

Link to the OperatingCompany associated with the Training Group.   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

TrainingGroup Name

 

 

 

X

 

Name of the Training Group e.g. Syllabus or Training Program name.   If this does not exist then a dummy entry should be created, e.g. MAS500 Training Group  

description

normalizedString

TrainingGroup Description

 

X

 

 

 

A longer description of the Training Group description of the Syllabus.    

associatedTrainingGroups

trainingGroup*

TrainingGroup Associated TrainingGroups

 

X

 

 

association 

A link to other Training Groups associated with this one.    

training

training*

TrainingGroup Training

 

X

 

 

association 

Training associated with the Training Group.   See Training definition. Training can belong to multiple Training Groups.  

notes

note*

TrainingGroup Note

 

X

 

 

child 

Notes associated with Training Group.    

Top  

Resource workTime

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

WorkTime Active Flag

 

 

 

 

 

Flag to indicate if the WorkTime is an active one.    

reference

normalizedString

WorkTime Reference

X

 

 

 

 

Reference associated with the WorkTime.    

reference2

normalizedString

WorkTime Reference2

 

X

 

 

 

Another reference associated with the WorkTime.    

operatingCompany

operatingCompany

WorkTime OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Work Time.   See OperatingCompany definition Company where type = Operating Company.  

description

normalizedString

WorkTime Description

 

X

 

 

 

The type of work time – Full Time, Part Time 20 Hours, Afternoons only etc.    

lines

workTimeLine*

WorkTime Line

 

X

 

 

association 

A link to the Work Time Lines associated with this Work Time.   See Work Time Line definition  

notes

note*

WorkTime Note

 

X

 

 

child 

Note associated with the WorkTime   See Note definition.  

Top  

Resource workTimeLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

WorkTimeLine Active Flag

 

 

 

 

 

Flag to indicate if the WorkTimeLine is an active one.    

reference

normalizedString

WorkTimeLine Reference

X

 

 

 

 

Reference associated with the WorkTimeLine.    

reference2

normalizedString

WorkTimeLine Reference2

 

X

 

 

 

Another reference associated with the WorkTimeLine.    

description

normalizedString

WorkTimeLine Description

 

X

 

 

 

The type of Work Time Line – Saturday Morning, Afternoons only etc.    

unit

normalizedString

WorkTimeLine Unit

 

X

 

 

 

The unit of the WorkTimeLine e.g. hour, day, etc    

start

normalizedString

WorkTimeLine Start

 

X

 

 

 

The start point for the Work Time Line e.g. if the Unit is Day, then this would be the starting time of the day.    

end

normalizedString

WorkTimeLine End

 

X

 

 

 

The end point for the Work Time Line e.g. if the Unit is day, then this would be the finish time of the day.    

name

normalizedString

WorkTimeLine Name

 

X

 

 

 

The name of the Work Time Line e.g. if the Unit is Day, then this would be the name of the day – Monday, Tuesday, etc.    

value

workTimeLineValue

WorkTimeLine Value

 

X

 

 

 

The value associated with the WorkTimeLine either working, non-working.    

publicHolidayFlag

boolean

WorkTimeLine Public Holiday Flag

 

X

 

 

 

Flag to indicate if this entry is for a public holiday.   Default = False  

day

normalizedString

WorkTimeLine Day

 

X

 

 

 

The day of the week associated with the Work Time Line.    

date

date

WorkTimeLine Date

 

X

 

 

 

The date of the Work Time Line e.g. Xmas day or Easter days may be explicitly defined.    

primacyIndicator

boolean

WorkTimeLine Primacy Indicator

 

X

 

 

 

Where there may more than one Work Time Line entries for a particular day/date this field indicates which has primacy.   Default = False  

notes

note*

WorkTimeLine Note

 

X

 

 

child 

Note associated with the WorkTimeLine   See Note definition.  

Top  

Resource absence

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Absence Active Flag

 

 

 

 

 

Flag to indicate if the Absence is an active one.    

reference

normalizedString

Absence Reference

X

 

 

 

 

Reference for the Absence.    

reference2

normalizedString

Absence Reference2

 

X

 

 

 

Additional reference for the Absence.    

status

normalizedString

Absence Status

 

X

 

 

 

Status of the Absence    

payrollFlag

boolean

Absence Payroll Flag

 

X

 

 

 

Additional Boolean status flag to indicate impact on Payroll   True – include in Payroll False – not included in Payroll Also available on Absence Line.  

reason

absenceReason

Absence Reason

 

X

 

X

 

The reason for the absence.   Also available on Absence Line.  

operatingCompany

operatingCompany

Absence OperatingCompany

 

 

 

 

reference 

OperatingCompany associated with the Absence   See OperatingCompany definition Company where type = Operating Company.  

employee

employee

Absence Employee

 

 

 

 

reference 

Employee associated with the Absence   See Employee definition.  

employeeReference

normalizedString

Absence Employee Reference

 

X

 

 

 

Employees own reference for the Absence.    

notifiedFlag

boolean

Absence Notified Flag

 

X

 

 

 

Boolean flag to indicate if Absence was notified e.g. by the Employee    

notifiedDate

date

Absence Date Notified

 

X

 

 

 

Date the Absence was notified e.g. by the Employee.    

authorisedFlag

boolean

Absence Authorised Flag

 

X

 

 

 

Boolean flag to indicate if the Absence was authorised e.g. by the Employee manager or supervisor.    

authorisedDate

date

Absence Date Authorised

 

X

 

 

 

Date the Absence was authorised e.g. by the Employee manager or supervisor.    

selfCertifiedFlag

boolean

Absence Self Certified Flag

 

X

 

 

 

Flag to indicate if Absence is self-certified.    

selfCertifiedDate

date

Absence Self Certified Date

 

X

 

 

 

   

certifiedFlag

boolean

Absence Certified Flag

 

X

 

 

 

Boolean flag to indicate if Absence certified by external authority e.g. Doctor, Armed Forces – not applicable if self certified.    

certifiedDate

date

Absence Date Certified

 

X

 

 

 

Date the absence was certified e.g. by a Doctor – not applicable if self certified.    

startDate

date

Absence Start Date

 

 

 

 

 

Start date of the Absence.    

endDate

date

Absence End Date

 

 

 

 

 

End date of the Absence.    

certifiedStartDate

date

Absence Certified Start Date

 

X

 

 

 

Certified Start date of the Absence e.g. by Doctor, Armed Forces.   May be different from actual absence start date.  

certifiedEndDate

date

Absence Certified End Date

 

X

 

 

 

Certified End date of the Absence.   May be different from actual absence start date.  

absenceLines

absenceLine*

Absence AbsenceLine

 

 

 

 

child 

Absence Line detail.   See AbsenceLine definition.  

lineCount

decimal

Absence Line Count

 

 

 

 

 

The number of lines on the Absence.   Should be auto-populated. Used as a cross reference to ensure document integrity.  

unitTotal

decimal

Absence Unit Total

 

 

 

 

 

Total unit value of the Absence.   In Absence Unit.  

unit

absenceUnit

Absence Unit

 

 

 

 

 

Unit used on the Absence.    

workUnitTotal

decimal

Absence Work Unit Total

 

X

 

 

 

Total work unit value of the Absence.   In Work Absence Unit. E.g. Employee may be absent for a week 5 days but may only work part time – 3 days a week.  

workUnit

absenceWorkUnit

Absence Work Unit

 

X

 

 

 

Work Unit used on the Absence may differ from Absence unit.    

timesheets

timesheet*

Absence Timesheet

 

X

 

 

association 

For Absences entered via a Timesheet, this is a link to the Timesheet header   See Timesheet definition.  

payrolls

payroll*

Absence Payroll

 

X

 

 

association 

If the Absence forms part of a Payroll then this is a link to the Payroll entry.   See Payroll definition.  

text1

string

Absence Text1

 

X

 

 

 

Text/commentary on the Absence.   Header text  

text2

string

Absence Text2

 

X

 

 

 

Text/commentary on the Absence.   Footer text  

notes

note*

Absence Note

 

X

 

 

child 

Notes associated with an Absence.    

Top  

Resource absenceLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

AbsenceLine Active Flag

 

 

 

 

 

Flag to indicate if the Absence Line is an active one.    

reference

normalizedString

AbsenceLine Reference

X

 

 

 

 

Reference for the Absence.    

reference2

normalizedString

AbsenceLine Reference2

 

X

 

 

 

Additional reference for the Absence.    

status

normalizedString

AbsenceLine Status

 

X

 

 

 

Status of the Absence Line.    

payrollFlag

boolean

AbsenceLine Payroll Flag

 

X

 

 

 

Additional Boolean status flag to indicate impact on Payroll   True – include in Payroll False – not included in Payroll Default = From Absence header  

reason

absenceLineReason

AbsenceLine Reason

 

X

 

 

 

The reason for the absence.   Default = From Absence header  

number

decimal

AbsenceLine Number

 

 

 

 

 

The number of the Absence Line.   For sequencing and ordering of lines.  

text

string

AbsenceLine Text

 

X

 

 

 

Text applicable to the Absence Line.    

date

date

AbsenceLine Date

 

X

 

 

 

The date of the Absence Line.    

startTime

time

AbsenceLine StartTime

 

X

 

 

 

The start time of the Absence Line if time is tracked to this level of detail.    

endTime

time

AbsenceLine EndTime

 

X

 

 

 

The end time of the Absence Line if time is tracked to this level of detail.    

timeOfDateIndicator

absenceLineTimeOfDateIndicator

AbsenceLine Time of Day Indicator

 

X

 

 

 

A flag that indicates the time of day of the Absence Line if actual time recording not used.    

unitQuantity

decimal

AbsenceLine Unit Quantity

 

 

 

 

 

The quantity of the Absence Line.   Default to 1 if not used. In Absence Unit.  

workUnitQuantity

decimal

AbsenceLine Work Unit Quantity

 

X

 

 

 

The work quantity of the Absence Line.   Default to 1 if not used. In Absence Work Unit.  

timesheets

timesheet*

AbsenceLine Timesheet

 

X

 

 

association 

For Absences entered via a Timesheet, this is a link to the Timesheet header   See Timesheet definition.  

timesheetLines

timesheetLine*

AbsenceLine TimesheetLine

 

X

 

 

association 

For Absences entered via a Timesheet, this is a link to the Timesheet Line.   See TimesheetLine definition.  

payrollElement

payrollElement

AbsenceLine Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to the Absence Line.   See PayrollElement definition  

payrolls

payroll*

AbsenceLine Payroll

 

X

 

 

association 

If the Absence Line forms part of a Payroll then this is a link to the Payroll entry.   See Payroll definition.  

payrollLines

payrollLine*

AbsenceLine PayrollLine

 

X

 

 

association 

If the Absence Line forms part of a Payroll then this is a link to the Payroll Line entry.   See PayrollLine definition.  

notes

note*

AbsenceLine Note

 

X

 

 

child 

Notes associated with an Absence Line e.g. for credit control.    

Top  

Resource relatedParty

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

RelatedParty Active Flag

 

 

 

 

 

Flag to indicate if the Related Party is an active Related Party.    

reference

normalizedString

RelatedParty Reference

X

 

 

 

 

Reference for the Related Party e.g. Related Party/Payroll number.    

reference2

normalizedString

RelatedParty Reference2

 

X

 

 

 

Additional reference for the Related Party.    

status

normalizedString

RelatedParty Status

 

X

 

 

 

Status of the Related Party.    

type

normalizedString

RelatedParty Type

 

X

 

 

 

The Related Party type    

personalRelationship

relatedPartyPersonalRelationship

RelatedParty Personal Relationship

 

 

 

 

 

The personal relationship between the Related Party and the associated Employee.    

adoptedFlag

boolean

RelatedParty Adopted Flag

 

X

 

 

 

Flag indicating if the Related Party is adopted.   Default = False  

adoptedDate

date

RelatedParty Adopted Date

 

X

 

 

 

If the Related Party is adopted, then this is the effective date of the adoption.    

disabilityFlag

boolean

RelatedParty Disability Flag

 

X

 

 

 

A flag to indicate if the Related Party is registered disabled.    

gender

relatedPartyGender

RelatedParty Gender

 

X

 

 

 

The gender of the Related Party e.g. Male, Female, Not Specified.    

fullName

normalizedString

RelatedParty Full Name

 

 

 

X

 

The full name of the Related Party e.g. title, first name, family name, suitably spaced.   Formatted name for display purposes.  

salutation

normalizedString

RelatedParty Salutation

 

X

 

 

 

The salutation to be used when addressing the Related Party Dear, Your Excellency, etc.    

firstName

normalizedString

RelatedParty First Name

 

X

 

 

 

The first name of the Related Party.    

preferredName

normalizedString

RelatedParty Preferred Name

 

X

 

 

 

The name preferred by the Related Party – may be first name or a nick name.   Could use First Name as default  

familyName

normalizedString

RelatedParty Family Name

 

X

 

 

 

The family name surname of the Related Party.    

previousFamilyName

normalizedString

RelatedParty Previous Family name

 

X

 

 

 

Any previous family name used by the Related Party before marriage.    

title

normalizedString

RelatedParty Title

 

X

 

 

 

The title of the Related Party.   Language-specific  

middleName

normalizedString

RelatedParty Middle Name

 

X

 

 

 

The middle name of the Related Party.    

suffix

normalizedString

RelatedParty Suffix

 

X

 

 

 

A name suffix associated with the .Related Party e.g. PhD, OBE, etc    

age

decimal

RelatedParty Age

 

X

 

 

 

The age of the Related Party.   Could be calculated from date of birth.  

dateOfBirth

date

RelatedParty Date Of Birth

 

X

 

 

 

The date of birth of the Related Party.    

nationality

normalizedString

RelatedParty Nationality

 

X

 

 

 

The nationality of the Related Party.    

countryOfResidence

normalizedString

RelatedParty Country of Residence

 

X

 

 

 

The country of residence of the Related Party.   ISO 3166-1 alpha-2 country codes only  

postalAddresses

postalAddress*

RelatedParty PostalAddresses

 

X

 

 

child 

Link to the Related Party addresses e.g. home address.   See PostalAddress definition.  

phones

phoneNumber*

RelatedParty Phones

 

X

 

 

child 

Related Party telephone numbers.   See PhoneNumber definition.  

emails

email*

RelatedParty Emails

 

X

 

 

child 

Related Party email addresses.   See Email definition.  

website

normalizedString

RelatedParty Web site

 

X

 

 

 

Related Party web site address.    

employees

employee*

RelatedParty Employee

 

X

 

 

association 

Link to the Employee associated with the Related Party.   See Employee definition.  

emergencyContacts

relatedParty*

RelatedParty Emergency Contacts

 

X

 

 

association 

Emergency contact details for the Related Party in case of accident/illness   See Related Party definition.  

isBeneficiary

boolean

RelatedParty Is Beneficiary

 

X

 

 

 

Flag to indicate If Related Party is a potential Beneficiary e.g. of Life Insurance    

beneficiaryAllocation

decimal

RelatedParty Beneficiary Allocation

 

X

 

 

 

If Related Party is a potential Beneficiary e.g. of Life Insurance then this gives the allocation of benefit e.g. 100 percent if there is only one beneficiary, 50 percent if there are two split equal.    

notes

note*

RelatedParty Note

 

X

 

 

child 

Notes associated with a Related Party.    

Top  

Resource payrollElement

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

PayrollElement Active Flag

 

 

 

 

 

Flag to indicate if the Payroll Element is an active Payroll Element .    

reference

normalizedString

PayrollElement Reference

X

 

 

 

 

Reference for the Payroll Element e.g. Payroll Element/Payroll number.    

reference2

normalizedString

PayrollElement Reference2

 

X

 

 

 

Additional reference for the Payroll Element.    

status

normalizedString

PayrollElement Status

 

X

 

 

 

Status of the Payroll Element.    

operatingCompany

operatingCompany

PayrollElement OperatingCompany

 

X

 

 

reference 

The Operating Company owning the Payroll Elements   See OperatingCompany definition Company where type = Operating Company.  

type

payrollElementType

PayrollElement Type

 

 

 

 

 

The Payroll Element type.    

name

normalizedString

PayrollElement Name

 

 

 

X

 

The name of the Payroll Element e.g. Standard Time, Double Time.    

multiplier

decimal

PayrollElement Multiplier

 

 

 

 

 

The Payroll Element may be used to drive multiples of Payroll work, e.g. Double Time implies Standard Time x 2   Default = 1  

absenceCategory

payrollElementAbsenceCategory

PayrollElement Absence Category

 

 

 

 

 

Flag to indicate type of absence to be accrued when this Payroll Element is used.    

rates

rate*

PayrollElement Rates

 

X

 

 

association 

Rates associated with the Payroll Element.   See Rate definition.  

financialAccounts

financialAccount*

PayrollElement FinancialAccount

 

X

 

 

association 

Financial Account that may be associated with the Payroll Element   See Financial Account definition.  

costCentres

costCentre*

PayrollElement CostCentre

 

X

 

 

association 

 

departments

department*

PayrollElement Department

 

X

 

 

association 

 

notes

note*

PayrollElement Note

 

X

 

 

child 

Notes associated with a Payroll Element.    

Top  

Resource expenseCategory

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

ExpenseCategory Active Flag

 

 

 

 

 

Flag to indicate if the Expense Category is an active Expense Category .    

reference

normalizedString

ExpenseCategory Reference

X

 

 

 

 

Reference for the Expense Category e.g. Expense Category/Payroll number.    

reference2

normalizedString

ExpenseCategory Reference2

 

X

 

 

 

Additional reference for the Expense Category.    

status

normalizedString

ExpenseCategory Status

 

X

 

 

 

Status of the Expense Category.    

operatingCompany

operatingCompany

ExpenseCategory OperatingCompany

 

 

 

 

reference 

The Operating Company owning the Expense Categorys   See OperatingCompany definition Company where type = Operating Company.  

category

normalizedString

ExpenseCategory Category

 

 

 

 

 

The category of the Expense Claim Line e.g. Accommodation, Travel.    

subcategory

normalizedString

ExpenseCategory SubCategory

 

X

 

 

 

The sub-category of the Expense Claim Line e.g. Hotel, Car Hire    

defaultQuantity

decimal

ExpenseCategory Default Quantity

 

 

 

 

 

The default quantity associated with this Expense Category typically 1   Default = 1  

unitBasedFlag

normalizedString

ExpenseCategory Unit Based flag

 

 

 

 

 

Flag to indicate if this Expense Category is unit based e.g. Mileage.    

unit

expenseCategoryUnit

ExpenseCategory Unit

 

X

 

 

 

If this Expense Category is unit based, then this is the Unit used.    

unitDefaultRate

decimal

ExpenseCategory Unit Default Rate

 

X

 

 

 

The default per-unit Rate used on the Expense Category e.g. 30p per mile.   Currency agnostic – currency will come from Expense Claim.  

isTaxableFlag

boolean

ExpenseCategory Is Taxable Flag

 

X

 

 

 

Flag to indicate if this Expense Category is taxable.    

taxCodes

taxCode*

ExpenseCategory Tax Code

 

X

 

 

association 

Tax Code to be used for Expense Categories that are taxable.   See Tax Code definition.  

financialAccounts

financialAccount*

ExpenseCategory FinancialAccount

 

X

 

 

association 

Financial Account that may be associated with the Expense Category   See Financial Account definition.  

costCentres

costCentre*

ExpenseCategory CostCentre

 

X

 

 

association 

 

departments

department*

ExpenseCategory Department

 

X

 

 

association 

 

notes

note*

ExpenseCategory Note

 

X

 

 

child 

Notes associated with an Expense Category.    

Top  

Resource rate

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Rate Active Flag

 

 

 

 

 

Flag to indicate if the Rate is an active Rate.    

reference

normalizedString

Rate Reference

X

 

 

 

 

Reference for the Rate    

reference2

normalizedString

Rate Reference2

 

X

 

 

 

Additional reference for the Rate.    

status

normalizedString

Rate Status

 

X

 

 

 

Status of the Rate.    

operatingCompany

operatingCompany

Rate OperatingCompany

 

X

 

 

reference 

The Operating Company owning the Rates   See OperatingCompany definition Company where type = Operating Company.  

name

normalizedString

Rate Name

 

X

 

 

 

The name of the rate e.g. Cost Rate, Charge Rate, Pay Rate.    

type

rateType

Rate Type

 

 

 

 

 

The type of Rate    

unit

rateUnit

Rate Unit

 

X

 

 

 

The unit the rate is applicable to e.g. per day or per hour.    

unitValue

decimal

Rate Unit Value

 

X

 

 

 

The value associated with the rate e.g. USD200 per day.    

projects

project*

Rate Project

 

X

 

 

association 

Identifier of the Project this Rate is for if any.   See Project definition. CRM schema  

projectLines

projectLine*

Rate ProjectLine

 

X

 

 

association 

Project Line value for this Rate.   See Project Line definition. CRM schema Some applications may not have Project Lines.  

employees

employee*

Rate Employee

 

X

 

 

association 

For Employee-specific rates, this is a link to the Employees   See Employee definition.  

payrollElement

payrollElement

Rate Payroll Element

 

X

 

 

reference 

The Payroll element describes the type of Payroll processing applicable to this Rate e.g. if Rate Type = Pay.   See PayrollElement definition  

isTaxableFlag

boolean

Rate Is Taxable Flag

 

X

 

 

 

Flag to indicate if this Rate is taxable.   Default = True  

taxCodes

taxCode*

Rate Tax Code

 

X

 

 

association 

Tax Code to be used for Rates that are taxable.   See Tax Code definition.  

financialAccounts

financialAccount*

Rate FinancialAccount

 

X

 

 

association 

Financial Account that may be associated with the Rate   See Financial Account definition. CRM schema  

costCentres

costCentre*

Rate CostCentre

 

X

 

 

association 

 

departments

department*

Rate Department

 

X

 

 

association 

 

effectiveDate

date

Rate Effective Date

 

X

 

 

 

Effective date of the Rate.    

notes

note*

Rate Note

 

X

 

 

child 

Notes associated with a Rate.    

Top  

Resource fixedAsset

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

FixedAsset Active Flag

 

 

 

 

 

Flag to indicate if the Fixed Asset is an ‘active’ one .   Default = True  

FixedAssetGroup

fixedAssetGroup*

FixedAsset FixedAssetGroup

 

X

 

 

association 

Identifier of the Fixed Asset group this Fixed Asset belongs to.   See “FixedAssetGroup” definition. FixedAssets can only belong to one FixedAsset Group of type “Family”, but may belong to many groups of type “user defined”.  

reference

string

FixedAsset reference

X

 

 

 

 

reference for the Fixed Asset (typically the one used by the buying organization).    

reference2

string

FixedAsset Reference2

 

X

X

 

 

Another reference for the Fixed Asset.    

operatingCompany

operatingCompany

FixedAsset OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Fixed Asset.   See “Company” definition (where Company Type = “Operating Company”).  

workplace

workplace

FixedAsset Workplace

 

X

 

 

reference 

Link to the Workplace (within the Operating Company) associated with the Fixed Asset   See “Workplace” definition  

status

string

FixedAsset Status

 

X

X

 

 

Status of the Fixed Asset.    

ownershipStatus

fixedAssetOwnershipStatus

FixedAsset Ownership Status

 

X

 

 

 

Status of ownership for the Fixed Asset (planned – also known as expenditure - or actual).    

schedule

fixedAssetSchedule*

FixedAsset Schedule

 

X

 

 

association 

A link to the (depreciation) schedule associated with the Fixed Asset.   See “FixedAssetSchedule” definition. An asset may be on more than one schedule as there may be one for tax and one for accounting.  

name

string

FixedAsset Name

 

X

 

X

 

Name for the Fixed Asset.    

shortName

string

FixedAsset Short Name

 

X

 

 

 

A shorter name for the Fixed Asset.    

description

string

FixedAsset Description

 

X

 

 

 

The Fixed Asset description.    

alternativeDescription1

string

FixedAsset Alternative Description 1

 

X

X

 

 

An alternative Fixed Asset description.    

alternativeDescription2

string

FixedAsset Alternative Description 2

 

X

X

 

 

Another alternative Fixed Asset description.    

holdingTerms

fixedAssetHoldingTerms

FixedAsset Holding Term

 

 

 

 

 

The Fixed Asset holding terms (clarifies ownership terms around the asset)    

contractReference

string

FixedAsset Contract Reference

 

X

 

 

 

For holding terms that are either leasing contract, or concession, there may be an associated contract – this is the contract reference.    

assetType

fixedAssetAssetType

FixedAsset Asset Type

 

X

 

 

 

The asset type associated with the Fixed Asset.    

permanence

fixedAssetPermanence

FixedAsset Permanence

 

X

 

 

 

Flag to indicate the permanence (or otherwise) of the Fixed Asset.    

catalogueNumber

string

FixedAsset Catalogue Number

 

X

 

 

 

reference for the Fixed Asset in a Supplier catalogue.    

supplierTradingAccount

tradingAccount*

FixedAsset Supplier TradingAccount

 

X

 

 

association 

Link to the Fixed Asset Supplier trading account.   See “TradingAccount” definition (CRM schema).  

supplierReference

string

FixedAsset Supplier reference

 

X

 

 

 

reference for the Fixed Asset as used by the Supplier.    

manufacturerCompany

string

FixedAsset Manufacturer Company

 

X

X

 

reference 

Link to the Company associated with manufacturing the Fixed Asset.   See “Company” definition (CRM schema).  

manufacturerReference

string

FixedAsset Manufacturer reference

 

X

X

 

 

reference for the Fixed Asset as used by the manufacturer.    

legalTaxCodes

taxCode*

FixedAsset Legal Tax Code

 

X

 

 

association 

Tax codes governing the legal tax applicable to this Fixed Asset (e.g. VAT, GST).   See “TaxCode” definition (CRM schema).  

legalTaxRecoveryFlag

fixedAssetLegalTaxRecoveryFlag

FixedAsset Legal Tax Recovery Flag

 

X

 

 

 

Flag to indicate if legal tax (VAT, GST) is recoverable on the Fixed Asset.    

legalTaxRecoveryCodes

taxCode*

FixedAsset Legal Tax Recovery Code

 

X

 

 

association 

Tax codes governing what legal tax is recoverable (if legal tax recovery flag = recoverable)   See “TaxCode” definition (CRM schema).  

IASTaxCodes

taxCode*

FixedAsset IAS Tax Code

 

X

 

 

association 

Tax codes governing the IAS tax applicable to this Fixed Asset (e.g. VAT, GST).   See “TaxCode” definition (CRM schema).  

IASTaxRecoveryFlag

string

FixedAsset IAS Tax Recovery Flag

 

X

 

 

 

Flag to indicate if IAS tax (VAT, GST) is recoverable on the Fixed Asset.   Recoverable Non-Recoverable  

IASTaxRecoveryCodes

taxCode*

FixedAsset IAS Tax Recovery Code

 

X

 

 

association 

Tax codes governing what IAS tax is recoverable (if IAS tax recovery flag = recoverable)   See “TaxCode” definition (CRM schema).  

legalFinancialAccountGroup

financialAccountGroup*

FixedAsset Legal FinancialAccountGroup

 

X

 

 

association 

Link to the legal Financial Account Group associated with this Fixed Asset.   See “Financial Account Group” definition.  

legalFinancialAccounts

financialAccount*

FixedAsset Legal FinancialAccount

 

X

 

 

association 

Legal financial accounting code applicable to the Fixed Asset.   See “FinancialAccount” definition (CRM schema).  

legalCostCentres

costCentre*

Fixed Asset legal CostCentre

 

X

 

 

association 

 

legalDepartments

department*

Fixed Asset Legal Departments

 

X

 

 

association 

 

IASFinancialAccountGroup

financialAccountGroup*

FixedAsset IAS FinancialAccountGroup

 

X

 

 

association 

Link to the IAS Financial Account Group associated with this Fixed Asset.   See “Financial Account Group” definition.  

IASFinancialAccounts

financialAccount*

FixedAsset IAS FinancialAccount

 

X

 

 

association 

IAS financial accounting code applicable to the Fixed Asset.   See “FinancialAccount” definition (CRM schema).  

IASCostCentres

costCentre*

Fixed Asset IAS CostCentre

 

X

 

 

association 

 

IASDepartments

department*

Fixed Asset IAS Departments

 

X

 

 

association 

 

tradeIdentificationNumber

string

FixedAsset Trade Identification Number

X

X

 

 

 

The GTIN (global trade identification number) for the Fixed Asset (e.g. EAN-13, UPC-13 for barcodes).   Used for handling bar codes.  

replacement

fixedAsset

FixedAsset Replacement

 

X

 

 

reference 

If this Fixed Asset has been superseded this is a link to the ‘new’ Fixed Asset.   See “FixedAsset” definition.  

replacementDate

date

FixedAsset Replacement Date

 

X

 

 

 

For superceded or replaced Fixed Assets, this is the start date of the replacement.    

currency

string

FixedAsset Currency

 

X

 

 

 

The currency of the Fixed Asset (e.g. GBP, USD, EUR).    

operatingCompanyCurrency

string

FixedAsset OperatingCompany Currency

 

X

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the “base” currency).    

operatingCompanyCurrencyExchangeRate

decimal

FixedAsset OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Fixed Asset Currency into Fixed Asset OperatingCompany Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

fixedAssetOperatingCompanyCurrencyExchangeRateOperator

FixedAsset OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Fixed Asset Currency to Fixed Asset OperatingCompany Currency.   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Operating Company Currency Exchange Rate = Sales Order Values in Sales Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

FixedAsset OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Fixed Asset Currency to Fixed Asset OperatingCompany Currency, if different.   Default = System date  

legalCost

decimal

FixedAsset Legal Cost

 

X

 

 

 

Depending on the costing method used, this is the “cost” of the Fixed Asset.    

IASCost

decimal

FixedAsset IAS Cost

 

X

 

 

 

Depending on the costing method used, this is the “cost” of the Fixed Asset.    

legalNatureOfAsset

string

FixedAsset Legal Nature of Asset

 

X

 

 

 

The legal nature of the Fixed Asset    

IASNatureOfAsset

string

FixedAsset IAS Nature of Asset

 

X

 

 

 

The IAS nature of the Fixed Asset    

purchaseRequisitionLines

purchaseRequisitionLine*

FixedAsset Purchase Requisition Line

 

X

 

 

association 

Purchase Requisition Line(s) associated with the Fixed Asset.   See “PurchaseRequisitionLine” definition (CRM schema).  

purchaseOrderLines

purchaseOrderLine*

FixedAsset Purchase Order Line

 

X

 

 

association 

Purchase Order Line(s) associated with the Fixed Asset.   See “PurchaseOrderLine” definition (CRM schema).  

purchaseOrderDeliveryLines

purchaseOrderDeliveryLine*

FixedAsset Purchase Order Delivery Line

 

X

 

 

association 

Purchase Order Delivery Line(s) associated with the Fixed Asset.   See “PurchaseOrderDeliveryLine” definition (CRM schema).  

purchaseInvoiceLines

purchaseInvoiceLine*

FixedAsset Purchase Invoice Line

 

X

 

 

association 

Purchase Invoice Line(s) associated with the Fixed Asset.   See “PurchaseInvoiceLine” definition (CRM schema).  

purchaseReturnLines

purchaseReturnLine*

FixedAsset Purchase Return Line

 

X

 

 

association 

Purchase Return Line(s) associated with the Fixed Asset.   See “PurchaseReturnLine” definition (CRM schema).  

purchaseReturnDeliveryLines

purchaseReturnDeliveryLine*

FixedAsset Purchase Return Delivery Line

 

X

 

 

association 

Purchase Return Delivery Line(s) associated with the Fixed Asset.   See “PurchaseReturnDeliveryLine” definition (CRM schema).  

purchaseCreditLines

purchaseCreditLine*

FixedAsset Purchase Credit Line

 

X

 

 

association 

Purchase Credit Line(s) associated with the Fixed Asset.   See “PurchaseCreditLine” definition (CRM schema).  

useCommoditiesFlag

boolean

FixedAsset Use Commodities Flag

 

X

 

 

 

Flag to indicate if Fixed Asset is created from Commodities (see below).   Default = “False”  

commodity

commodity*

FixedAsset Commodity

 

X

 

 

association 

A link to the associated Commodity that created the Fixed Asset. Commodities are products/items that can be bought that can be turned into Fixed Assets.   See “Commodity” definition (CRM schema).  

lease

lease

FixedAsset Lease

 

X

 

 

reference 

For Fixed Assets that are leased, this is a link to the lease.   See “Lease” definition.  

grant

grant

FixedAsset Grant

 

X

 

 

reference 

For Fixed Assets that have a grant associated with them, this is a link to the grant.   See “Grant” definition.  

project

project

FixedAsset Project

 

X

 

 

reference 

Project associated with the Fixed Asset.   See “Project” definition (CRM schema).  

unitOfMeasure

unitOfMeasure

FixedAsset Unit Of Measure

 

X

 

 

reference 

A link to the associated unit of measure for the Fixed Asset. Units of measure cover each, pack sizes, etc.   See “Unit Of Measure” definition (CRM schema).  

quantity

decimal

FixedAsset Quantity

 

X

 

 

 

The quantity of the Fixed Asset.   Default to 1  

associatedChildFixedAsset

fixedAsset*

FixedAsset Associated Child FixedAsset

 

X

 

 

child 

Link to Child Fixed Asset associated with this Fixed Asset.   FixedAssets can be ‘nested’ to create FixedAsset hierarchies.  

associatedParentFixedAsset

fixedAsset

FixedAsset Associated Parent FixedAsset

 

X

 

 

parent 

Link to Parent Fixed Asset associated with this Fixed Asset.   FixedAssets can be ‘nested’ to create FixedAsset hierarchies.  

cashGeneratingUnit

string

FixedAsset Cash Generating Unit

 

X

 

 

 

The cash generating unit associated with the Fixed Asset (IAS).    

businessUnit

string

FixedAsset Business Unit

 

X

 

 

 

The business unit associated with the Fixed Asset (IAS).    

geographicalUnit

string

FixedAsset Geographical Unit

 

X

 

 

 

The geographical unit associated with the Fixed Asset (IAS).    

lastTransferDate

date

FixedAsset Last Transfer Date

 

X

 

 

 

Date the Fixed Asset was last transferred.    

acquisitionType

fixedAssetAcquisitionType

FixedAsset Acquisition Type

 

X

 

 

 

The type of acquisition (if applicable) that resulted in the Fixed Asset becoming part of the Operating Company.    

acquisitionDate

date

FixedAsset Acquisition Date

 

X

 

 

 

If the Fixed Asset was via an acquisition, then this is the acquisition date.    

postingDate

date

FixedAsset Posting Date

 

X

 

 

 

The date the Fixed Asset was posted to the system (may be different from acquisition date).    

operationalDate

date

FixedAsset Operational Date

 

X

 

 

 

Date the Fixed Asset was put into operation (service).    

purchaseType

fixedAssetPurchaseType

FixedAsset Purchase Type

 

X

 

 

 

For Fixed Assets that are of acquisition type = Purchase, this is the type of purchase that was made.    

purchaseDate

string

FixedAsset Purchase Date

 

X

 

 

 

For Fixed Assets that are of acquisition type = Purchase, this is the date that the purchase was made.    

lastServiceDate

date

FixedAsset Last Service Date

 

X

 

 

 

Date the Fixed Asset was last serviced.    

saleAllowed

boolean

FixedAsset Sale Allowed Flag

 

X

 

 

 

Flag to indicate if the Fixed Asset is available for sale.    

dateSaleAllowed

date

FixedAsset Date Sale Allowed

 

X

 

 

 

For Fixed Assets that are made available for sale, this is the date they were made available for sale.    

saleDate

date

FixedAsset Sale Date

 

X

 

 

 

Date the Fixed Asset was sold (if applicable).    

businessUseUnit

fixedAssetBusinessUseUnit

FixedAsset Business Use Unit

 

X

 

 

 

Flag to indicate the business use unit applicable to the Fixed Asset (percent or amount or unit)    

businessUseValue

decimal

FixedAsset Business Use Value

 

X

 

 

 

The value of the Fixed Asset used for business use, expressed in business use rate type, e.g. 100 percent used for business, 50 units used for business, etc. The proportion not used for business is normally associated with private/personal use.    

fixedAssetEvents

fixedAssetEvent*

FixedAsset Fixed Asset Events

 

X

 

 

association 

A link to all of the Fixed Asset Events associated with the Fixed Asset.   See “Fixed Asset Event” definition.  

employees

employee*

FixedAsset Employees

 

X

 

 

association 

A link to the Employee(s) associated with the Fixed Asset   See “Employee” definition (inherited from HRM schema).  

benefit

benefit*

FixedAsset Benefit

 

X

 

 

association 

A link to the human resource Benefit that this Fixed Asset may be for (e.g. could be a labtop loan).   See “Benefit” definition (HRM schema).  

vehicles

vehicle*

FixedAsset Vehicles

 

X

 

 

association 

A link to the Vehicle(s) associated with the Fixed Asset   See “Vehicle” definition (inherited from HRM schema).  

notes

note*

FixedAsset Note

 

X

 

 

child 

Notes associated with a Fixed Asset.   See “Note” definition (CRM schema).  

Top  

Resource fixedAssetGroup

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

FixedAssetGroup Active Flag

 

 

 

 

 

Flag to indicate if the Fixed Asset Group is an ‘active’ one .   Default = True  

reference

string

FixedAssetGroup reference

X

 

 

 

 

reference for the Fixed Asset Group.    

reference2

string

FixedAssetGroup Reference2

 

X

X

 

 

Another reference for the Fixed Asset Group.    

operatingCompany

operatingCompany

FixedAssetGroup OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Fixed Asset Group.   See “Company” definition (where Company Type = “Operating Company”).  

type

fixedAssetGroupType

FixedAssetGroup Type

 

X

 

 

 

The type of Fixed Asset Group (Asset Family or User defined). Typically a Fixed Asset will belong to 1 Asset Family, but may belong to many user-defiend groups).    

name

string

FixedAssetGroup Name

 

 

 

X

 

Name of the Fixed Asset Group.   If this does not exist then a dummy entry should be created, e.g. “MAS500 Fixed Assets”  

description

string

FixedAssetGroup Description

 

X

 

 

 

A longer description of the Fixed Asset Group.    

fixedAssets

fixedAsset*

FixedAssetGroup FixedAsset

 

X

 

 

association 

Fixed Assets associated with the FixedAsset Group.   See “Fixed Asset” definition. FixedAssets can belong to multiple FixedAsset Groups.  

notes

note*

FixedAssetGroup Note

 

X

 

 

child 

Notes associated with a Fixed Asset Group.    

Top  

Resource fixedAssetSchedule

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

FixedAssetSchedule Active Flag

 

 

 

 

 

Flag to indicate if the Fixed Asset Schedule is an ‘active’ one .   Default = True  

reference

string

FixedAssetSchedule Reference

X

 

 

 

 

Reference associated with the Fixed Asset Schedule.    

reference2

string

FixedAssetSchedule Reference2

 

X

X

 

 

Another reference associated with the Fixed Asset Schedule.    

operatingCompany

operatingCompany

FixedAssetSchedule OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Fixed Asset Schedule.   See “Company” definition (where Company Type = “Operating Company”).  

name

string

FixedAssetSchedule Name

 

 

 

X

 

Name of the Fixed Asset Schedule.    

fixedAsset

fixedAsset*

FixedAssetSchedule FixedAsset

 

X

 

 

association 

A link to the Fixed Asset(s) associated with the schedule.   See “Fixed Asset” definition.  

description

string

FixedAssetSchedule Description

 

X

 

 

 

Textual description of the Fixed Asset Schedule.    

type

fixedAssetScheduleType

FixedAssetSchedule Type

 

X

 

 

 

The type of Fixed Asset Schedule (plan type for example).    

accountingType

string

FixedAssetSchedule Accounting Type

 

X

 

 

 

The type of accounting used by the Fixed Asset Schedule, e.g. GAAP, IFRS, other    

status

fixedAssetScheduleStatus

FixedAssetSchedule Status

 

 

 

 

 

Status of the Fixed Asset Schedule.    

duration

decimal

FixedAssetSchedule Duration

 

X

 

 

 

The Actual/planned duration of the Fixed Asset Schedule, in duration unit.    

durationUnit

fixedAssetScheduleDurationUnit

FixedAssetSchedule Duration Unit

 

X

 

 

 

The unit used for duration.    

year

decimal

FixedAssetSchedule Year

 

X

 

 

 

Year associate with the Fixed Asset Schedule (where a schedule spans multiple years there will be multiple fixed asset schedules)    

period

string

FixedAssetSchedule Period

 

X

 

 

 

Period associate with the Fixed Asset Schedule    

isCurrent

boolean

FixedAssetSchedule Is Current Flag

 

X

 

 

 

Flag to indicate if this Fixed Asset Schedule is the current on.    

dateFrom

date

FixedAssetSchedule Date From

 

X

 

 

 

The date the Fixed Asset Schedule started.    

dateTo

date

FixedAssetSchedule Date To

 

X

 

 

 

The date (actual/planned) the Fixed Asset Schedule finished.    

dateCurrent

date

FixedAssetSchedule Date Current

 

X

 

 

 

The current date of the Fixed Asset Schedule.    

previousSchedule

fixedAssetSchedule

FixedAssetSchedule Previous Schedule

 

X

 

 

association 

A link to a previous Fixed Asset Schedule that this schedule is related to (e.g. for multiple years, this will point to the schedule for the previous year).    

associatedChildFixedAssetSchedule

fixedAssetSchedule*

FixedAssetSchedule Associated Child FixedAssetSchedule

 

X

 

 

child 

Link to Child Fixed Asset Schedule associated with this Fixed Asset Schedule.   FixedAssetSchedules can be ‘nested’ to create FixedAssetSchedule hierarchies (e.g. a parent schedule could be for a year, whereas the child schedules could be for periods).  

associatedParentFixedAssetSchedule

fixedAssetSchedule

FixedAssetSchedule Associated Parent FixedAssetSchedule

 

X

 

 

parent 

Link to Parent Fixed Asset Schedule associated with this Fixed Asset Schedule.   FixedAssetSchedules can be ‘nested’ to create FixedAssetSchedule hierarchies (e.g. a parent schedule could be for a year, whereas the child schedules could be for periods).  

depreciationMethod

fixedAssetScheduleDepreciationMethod

FixedAssetSchedule Depreciation Primary Method

 

X

 

 

 

The primary method used for depreciation on the Fixed Asset Schedule.    

depreciationSecondaryMethod

string

FixedAssetSchedule Depreciation Secondary Method

 

X

 

 

 

The secondary method used for depreciation on the Fixed Asset Schedule – could be country, asset or time specific.   A primary method must be provided. The secondary method is used to further clarify the primary method – e.g. if the primary method is “user defined” then this method would describe the user definition.  

currency

string

FixedAssetSchedule Currency

 

X

 

 

 

The currency of the Fixed Asset Schedule (e.g. GBP, USD, EUR).   ISO 4217.  

operatingCompanyCurrency

string

FixedAssetSchedule OperatingCompany Currency

 

X

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the “base” currency).   ISO 4217.  

operatingCompanyCurrencyExchangeRate

decimal

FixedAssetSchedule OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Fixed Asset Schedule Currency into Fixed Asset Schedule OperatingCompany Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

fixedAssetScheduleOperatingCompanyCurrencyExchangeRateOperator

FixedAssetSchedule OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Fixed Asset Schedule Currency to Fixed Asset Schedule OperatingCompany Currency.   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Operating Company Currency Exchange Rate = Sales Order Values in Sales Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

FixedAssetSchedule OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Fixed Asset Schedule Currency to Fixed Asset Schedule OperatingCompany Currency, if different.   Default = System date  

depreciationRateType

fixedAssetScheduleDepreciationRateType

FixedAssetSchedule Depreciation Rate Type

 

X

 

 

 

Flag to indicate the type of depreciation rate applicable to the Fixed Asset Schedule (percent or amount)    

depreciationRateAmount

decimal

FixedAssetSchedule Depreciation Rate Amount

 

X

 

 

 

Deprecitation applicable to the Fixed Asset Schedule expressed as an amount (e.g. gross amount).   Fixed Asset Schedule Currency.  

depreciationRatePercent

decimal

FixedAssetSchedule Depreciation Rate Percent

 

X

 

 

 

Deprecitation applicable to the Fixed Asset Schedule expressed as a percent (e.g. of the current book value).    

depreciationRateUnit

decimal

FixedAssetSchedule Depreciation Rate Unit

 

X

 

 

 

Deprecitation applicable to the Fixed Asset Schedule expressed as a unit.    

bookValueStart

decimal

FixedAssetSchedule Book Value Start

 

X

 

 

 

The book value of the Fixed Asset associated with the Fixed Asset Schedule as at the start of the schedule (e.g. start of year).   Fixed Asset Schedule Currency.  

bookValueCurrent

decimal

FixedAssetSchedule Book Value Current

 

X

 

 

 

The current book value of the Fixed Asset associated with the Fixed Asset Schedule.   Fixed Asset Schedule Currency.  

bookValueEnd

decimal

FixedAssetSchedule Book Value End

 

X

 

 

 

The book value of the Fixed Asset associated with the Fixed Asset Schedule as at the end of the schedule (e.g. end of year).   Fixed Asset Schedule Currency.  

depreciableValueStart

decimal

FixedAssetSchedule Depreciable Value Start

 

X

 

 

 

The depreciable value of the Fixed Asset associated with the Fixed Asset Schedule as at the start of the schedule (e.g. start of year).   Fixed Asset Schedule Currency.  

depreciableValueCurrent

decimal

FixedAssetSchedule Depreciable Value Current

 

X

 

 

 

The current depreciable value of the Fixed Asset associated with the Fixed Asset Schedule.   Fixed Asset Schedule Currency.  

depreciableValueEnd

decimal

FixedAssetSchedule Depreciable Value End

 

X

 

 

 

The depreciable value of the Fixed Asset associated with the Fixed Asset Schedule as at the end of the schedule (e.g. end of year).   Fixed Asset Schedule Currency.  

marketValueStart

decimal

FixedAssetSchedule Market Value Start

 

X

 

 

 

The Market value of the Fixed Asset associated with the Fixed Asset Schedule as at the start of the schedule (e.g. start of year).   Fixed Asset Schedule Currency.  

marketValueCurrent

decimal

FixedAssetSchedule Market Value Current

 

X

 

 

 

The current Market value of the Fixed Asset associated with the Fixed Asset Schedule.   Fixed Asset Schedule Currency.  

marketValueEnd

decimal

FixedAssetSchedule Market Value End

 

X

 

 

 

The Market value of the Fixed Asset associated with the Fixed Asset Schedule as at the end of the schedule (e.g. end of year).   Fixed Asset Schedule Currency.  

scrapValueStart

decimal

FixedAssetSchedule Scrap Value Start

 

X

 

 

 

The Scrap value of the Fixed Asset associated with the Fixed Asset Schedule as at the start of the schedule (e.g. start of year).   Fixed Asset Schedule Currency.  

scrapValueCurrent

decimal

FixedAssetSchedule Scrap Value Current

 

X

 

 

 

The current Scrap value of the Fixed Asset associated with the Fixed Asset Schedule.   Fixed Asset Schedule Currency.  

scrapValueEnd

decimal

FixedAssetSchedule Scrap Value End

 

X

 

 

 

The Scrap value of the Fixed Asset associated with the Fixed Asset Schedule as at the end of the schedule (e.g. end of year).   Fixed Asset Schedule Currency.  

impairmentValueStart

decimal

FixedAssetSchedule Impairment Value Start

 

X

 

 

 

The Impairment value of the Fixed Asset associated with the Fixed Asset Schedule as at the start of the schedule (e.g. start of year).   Fixed Asset Schedule Currency.  

impairmentValueCurrent

decimal

FixedAssetSchedule Impairment Value Current

 

X

 

 

 

The Impairment value of the Fixed Asset associated with the Fixed Asset Schedule for the current schedule (e.g. year).   Fixed Asset Schedule Currency.  

impairmentValueReversal

decimal

FixedAssetSchedule Impairment Value Reversal

 

X

 

 

 

The value of any Impairment reversals for the Fixed Asset associated with the Fixed Asset Schedule for the current schedule (e.g. year).   Fixed Asset Schedule Currency.  

impairmentValueEnd

decimal

FixedAssetSchedule Impairment Value End

 

X

 

 

 

The Impairment value of the Fixed Asset associated with the Fixed Asset Schedule as at the end of the schedule (e.g. end of year).   Fixed Asset Schedule Currency.  

revaluationValueStart

decimal

FixedAssetSchedule Revaluation Value Start

 

X

 

 

 

The Revaluation value of the Fixed Asset associated with the Fixed Asset Schedule as at the start of the schedule (e.g. start of year).   Fixed Asset Schedule Currency.  

revaluationValueCurrent

decimal

FixedAssetSchedule Revaluation Value Current

 

X

 

 

 

The revaluation value of the Fixed Asset associated with the Fixed Asset Schedule for the current schedule (e.g. year).   Fixed Asset bSchedule Currency.  

revaluationValueReversal

decimal

FixedAssetSchedule Revaluation Value Reversal

 

X

 

 

 

The value of any Revaluation reversals for the Fixed Asset associated with the Fixed Asset Schedule for the current schedule (e.g. year).   Fixed Asset Schedule Currency.  

revaluationValueEnd

decimal

FixedAssetSchedule Revaluation Value End

 

X

 

 

 

The Revaluation value of the Fixed Asset associated with the Fixed Asset Schedule as at the end of the schedule (e.g. end of year).   Fixed Asset Schedule Currency.  

revaluationSurplus

decimal

FixedAssetSchedule Revaluation Surplus

 

X

 

 

 

The amount of any surplus caused by revaluation (e.g. where asset is revalue above its previous valuation).   Fixed Asset Schedule Currency.  

lastDepreciationExpense

decimal

FixedAssetSchedule Last Depreciation Expense

 

X

 

 

 

Last depreciation amount financial expense (charge).   Fixed Asset Schedule Currency.  

cumulativeDepreciationExpense

decimal

FixedAssetSchedule Cumulative Depreciation Expense

 

X

 

 

 

The cumulative value of the depreciation amount financial expense (charge).   Fixed Asset Schedule Currency.  

lastExceptionDepreciationExpense

decimal

FixedAssetSchedule Last Exception Depreciation Expense

 

X

 

 

 

Last exception depreciation amount financial expense (charge).   Fixed Asset Schedule Currency.  

cumulativeExceptionDepreciationExpense

decimal

FixedAssetSchedule CumulativeException Depreciation Expense

 

X

 

 

 

The cumulative value of the exception depreciation amount financial expense (charge).   Fixed Asset Schedule Currency.  

derogatoryDepreciationExpense

decimal

FixedAssetSchedule Derogatory Depreciation Expense

 

X

 

 

 

Derogatory depreciation amount financial expense (charge) – typically depreciation expense (tax) – depreciation expense (accounting)..   Fixed Asset Schedule Currency.  

derogatoryDepreciationExpenseReversal

decimal

FixedAssetSchedule Derogatory Depreciation Expense Reversal

 

X

 

 

 

Derogatory depreciation amount financial expense (charge) reversal value – typically depreciation expense (tax) – depreciation expense (accounting)..   Fixed Asset Schedule Currency.  

text1

string

FixedAssetSchedule Text1

 

X

 

 

 

Textual information associated with the Fixed Asset Schedule.    

text2

string

FixedAssetSchedule Text2

 

X

 

 

 

Textual information associated with the Fixed Asset Schedule.    

financialAccounts

financialAccount*

FixedAssetSchedule FinancialAccount

 

X

 

 

association 

Financial accounting code applicable to the Fixed Asset Schedule (e.g. depreciation cost account).   See “FinancialAccount” definition.  

costCentres

costCentre*

FixedAssetSchedule CostCentre

 

X

 

 

association 

 

departments

department*

FixedAssetSchedule Departments

 

X

 

 

association 

 

fixedAssetEvents

fixedAssetEvent*

FixedAssetSchedule Fixed Asset Events

 

X

 

 

association 

A link to all of the Fixed Asset Events associated with the Fixed Asset Schedule.   See “Fixed Asset Event” definition.  

notes

note*

FixedAssetSchedule Note

 

X

 

 

child 

Notes associated with the Fixed Asset Schedule    

Top  

Resource fixedAssetEvent

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

FixedAssetEvent Active Flag

 

 

 

 

 

Flag to indicate if the Fixed Asset Event is an ‘active’ one .   Default = True  

reference

string

FixedAssetEvent reference

X

 

 

 

 

reference for the Fixed Asset Event.    

reference2

string

FixedAssetEvent Reference2

 

X

X

 

 

Additional reference for the Fixed Asset Event.    

name

string

FixedAssetEvent Name

 

 

 

X

 

Name of the Fixed Asset Event.    

operatingCompany

operatingCompany

FixedAssetEvent OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Fixed Asset Event.   See “Company” definition (where Company Type = “Operating Company”).  

relatedOperatingCompany

operatingCompany

FixedAssetEvent Related OperatingCompany

 

X

 

 

reference 

Link to any other OperatingCompany associated with the Fixed Asset Event e.g. when an Asset is transferred from one company to another this will typically be the receiving Operating Company.   See “Company” definition (where Company Type = “Operating Company”).  

status

fixedAssetEventStatus

FixedAssetEvent Status

 

X

 

 

 

Status of the Fixed Asset Event (e.g. approved, etc).    

assetLeaseGrantFlag

fixedAssetEventAssetLeaseGrantFlag

FixedAssetEvent Asset Lease Grant Flag

 

X

 

 

 

Flag to indicate if the Fixed Asset Event is for a Fixed Asset or a Lease.    

fixedAsset

fixedAsset

FixedAssetEvent FixedAsset

 

X

 

 

reference 

A link to the Fixed Asset associated with the event.   See “Fixed Asset” definition.  

schedule

fixedAssetSchedule*

FixedAssetEvent Schedule

 

X

 

 

association 

A link to the (depreciation) schedule associated with (and used to generate) the Fixed Asset Event.   See “FixedAssetSchedule” definition.  

lease

lease

FixedAssetEvent Lease

 

X

 

 

reference 

For Fixed Assets that are leased, this is a link to the lease.   See “Lease” definition.  

grant

grant

FixedAssetEvent Grant

 

X

 

 

reference 

For Fixed Assets that have a grant associated with them, this is a link to the grant.   See “Grant” definition.  

type

fixedAssetEventType

FixedAssetEvent Type

 

X

 

 

 

Type of Fixed Asset Event.    

subtype

string

FixedAssetEvent Sub-Type

 

X

 

 

 

Any sub-Type associated with the Fixed Asset Event (e.g. a “Fixed Asset Disposal”-type event may have a disposal type associated with it. This may also be an application specific description of the event, e.g. IML, for X3 Impairment on Fixed Asset Deletion (Cancellation)).    

date

date

FixedAssetEvent Creation Date

 

 

 

 

 

Date the Fixed Asset Event was raised.    

accountingDate

date

FixedAssetEvent Accounting Date

 

 

 

 

 

Used to indicate the point at which the Fixed Asset Event is accounted for.    

postingDate

date

FixedAssetEvent Posting Date

 

 

 

 

 

Used to indicate the point at which the Fixed Asset Event was posted (e.g. depreciation charge).    

currency

string

FixedAssetEvent Currency

 

 

 

 

 

The currency (e.g. GBP, USD, EUR) used on the Fixed Asset Event.    

operatingCompanyCurrency

string

FixedAssetEvent OperatingCompany Currency

 

 

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the “base” currency).    

operatingCompanyCurrencyExchangeRate

decimal

FixedAssetEvent OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Fixed Asset Event Currency into Fixed Asset Event OperatingCompany Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

fixedAssetEventOperatingCompanyCurrencyExchangeRateOperator

FixedAssetEvent OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Fixed Asset Event Currency to Fixed Asset Event OperatingCompany Currency.   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Fixed Asset Event Values in Fixed Asset Event Currency / Fixed Asset Event Operating Company Currency Exchange Rate = Fixed Asset Event Values in Fixed Asset Event OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

FixedAssetEvent OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Fixed Asset Event Currency to Fixed Asset Event OperatingCompany Currency, if different.   Default = System date  

user

string

FixedAssetEvent User

 

X

 

 

 

Link to the user who the Fixed Asset Event is for.   The ‘user’ resource will be defined in the future.  

originatorDocument

purchaseInvoice

FixedAssetEvent Originator Document Reference

 

X

 

 

reference 

Reference to another document that created the Fixed Asset Event (e.g. the purchase order or Invoice).    

originatorDocumentLine

purchaseInvoiceLine

FixedAssetEvent Originator Document Line Reference

 

X

 

 

reference 

Reference to a lineanother document that created the Fixed Asset Event (e.g. the purchase order line or Invoice line).    

proportionUnit

fixedAssetEventProportionUnit

FixedAssetEvent Proportion Unit

 

X

 

 

 

Flag to indicate the unit used to proportion the asset applicable to the Fixed Asset Event (percent or amount or unit) – used where events are ‘partial’ events e.g. effect 50 percent of asset.    

proportionValue

decimal

FixedAssetEvent Proportion Value

 

X

 

 

 

The value (proportion) of the Fixed Asset applicable to the Fixed Asset Event, expressed in proportion unit, e.g. 50 percent, 50 units, 1000 amount, etc. Used where events are ‘partial’ i.e. not effecting the full asset.   In Proportion Unit  

amount

decimal

FixedAssetEvent Amount

 

X

 

 

 

The amount of the Fixed Asset Event (e.g. Transfer value, Sale value, Purchase value).   In Fixed Asset Event Currency.  

taxAmount

decimal

FixedAssetEvent Tax Amount

 

X

 

 

 

The tax amount of the Fixed Asset Event (e.g. any tax/VAT on a disposal).   In Fixed Asset Event Currency.  

invoiceTaxAmount

decimal

FixedAssetEvent Invoice Tax Amount

 

X

 

 

 

The invoice tax amount of the Fixed Asset Event (e.g. any tax/VAT on a sale).   In Fixed Asset Event Currency.  

recoveredTaxAmount

decimal

FixedAssetEvent Recoved Tax Amount

 

X

 

 

 

The recovered tax amount of the Fixed Asset Event (e.g. not all tax/VAT on a sale may be recoverable).   In Fixed Asset Event Currency.  

taxReductionAmount

decimal

FixedAssetEvent Tax Reduction Amount

 

X

 

 

 

The tax reduction amount of the Fixed Asset Event.   In Fixed Asset Event Currency.  

taxAmountReversal

decimal

FixedAssetEvent Tax Amount Reversal

 

X

 

 

 

The tax amount reversal of the Fixed Asset Event (e.g. any tax/VAT reversal on a disposal or cancellation).   In Fixed Asset Event Currency.  

saleProceeds

decimal

FixedAssetEvent Sale Proceeds

 

X

 

 

 

The value of any sale proceeds associated with the Fixed Asset Event of type “Fixed Asset Sale” only.   In Fixed Asset Event Currency.  

otherProceeds

decimal

FixedAssetEvent Other Proceeds

 

X

 

 

 

The value of any other proceeds associated with the Fixed Asset Event.   In Fixed Asset Event Currency.  

gainLoss

decimal

FixedAssetEvent Gain Loss

 

X

 

 

 

The value of any gain or loss on the Fixed Asset Event.   In Fixed Asset Event Currency.  

deferredGainLoss

decimal

FixedAssetEvent Deferred Gain Loss

 

X

 

 

 

The value of any deferred gain or loss on the Fixed Asset Event.   In Fixed Asset Event Currency.  

expenses

decimal

FixedAssetEvent Expenses

 

X

 

 

 

The value of any expenses associated with the Fixed Asset Event e.g. cost of sale, cost of transfer, disposal costs, etc.   In Fixed Asset Event Currency.  

bookValueEnd

decimal

FixedAssetEvent Book Value End

 

X

 

 

 

The book value (new amount) of the Fixed Asset following the completion of the Fixed Asset Event. (e.g. end of period/year).   Fixed Asset Schedule Currency.  

priorBookValueEnd

decimal

FixedAssetEvent Prior Book Value End

 

X

 

 

 

The prior book value (old amount) of the Fixed Asset following the completion of the Fixed Asset Event. (e.g. end of period/year).   Fixed Asset Schedule Currency.  

text1

string

FixedAssetEvent Text1

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Fixed Asset Event   Header Text  

text2

string

FixedAssetEvent Text2

 

X

 

 

 

Text/commentary (e.g. special Delivery instructions) for the Fixed Asset Event   Footer Text  

revaluatedBalanceSheetValue

decimal

FixedAssetEvent Revaluated Balance Sheet Value

 

X

 

 

 

The balance sheet value (new amount) – following revaluation – of the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

priorRevaluatedBalanceSheetValue

decimal

FixedAssetEvent Prior Revaluated Balance Sheet Value

 

X

 

 

 

The balance sheet value (old/prior amount) – following revaluation – of the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

revaluatedVariance

decimal

FixedAssetEvent Revaluated Variance

 

X

 

 

 

The variance value – following revaluation – of the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

revaluatedReversal

decimal

FixedAssetEvent Revaluated Reversal

 

X

 

 

 

The reversal value – following revaluation – of the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

currentDepreciation

decimal

FixedAssetEvent Current Depreciation

 

X

 

 

 

The current (e.g. period/year) depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

currentDepreciationReversal

decimal

FixedAssetEvent Current Depreciation Reversal

 

X

 

 

 

The current (e.g. period/year) depreciation reversal amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

postedDepreciation

decimal

FixedAssetEvent Posted Depreciation

 

X

 

 

 

The posted depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

accumulatedPostedDepreciation

decimal

FixedAssetEvent Accumulated Posted Depreciation

 

X

 

 

 

The accumulated posted depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

financialYearPostedDepreciation

decimal

FixedAssetEvent Financial Year Posted Depreciation

 

X

 

 

 

The financial year posted depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

priorFinancialYearPostedDepreciation

decimal

FixedAssetEvent Prior Financial Year Posted Depreciation

 

X

 

 

 

The prior financial year posted depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

priorFinancialYearPostedDepreciationRecovery

decimal

FixedAssetEvent Prior Financial Year Posted Depreciation Recovery

 

X

 

 

 

The prior financial year posted depreciation recovery amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

closedPostedDepreciation

decimal

FixedAssetEvent Closed Posted Depreciation

 

X

 

 

 

The closed (period) posted depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

priorClosedPostedDepreciation

decimal

FixedAssetEvent Prior Closed Posted Depreciation

 

X

 

 

 

The prior closed (period) posted depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

postedExceptionDepreciation

decimal

FixedAssetEvent Posted Exception Depreciation

 

X

 

 

 

The posted exception depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

accumulatedPostedExceptionDepreciation

decimal

FixedAssetEvent Accumulated Posted Exception Depreciation

 

X

 

 

 

The accumulated posted exception depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

accumulatedPostedExceptionDepreciationTransfer

decimal

FixedAssetEvent Accumulated Posted Exception Depreciation Transfer

 

X

 

 

 

The accumulated posted exception depreciation transfer amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

financialYearPostedExceptionDepreciation

decimal

FixedAssetEvent Fomer Year Posted Exception Depreciation

 

X

 

 

 

The financial year posted exception depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

postedDerogatoryDepreciation

decimal

FixedAssetEvent Posted Derogatory Depreciation

 

X

 

 

 

The posted derogatory depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

accumulatedPostedDerogatoryDepreciation

decimal

FixedAssetEvent Accumulated Posted Derogatory Depreciation

 

X

 

 

 

The accumulated posted derogatory depreciation amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

postedDerogatoryDepreciationReversal

decimal

FixedAssetEvent Posted Derogatory Depreciation Reversal

 

X

 

 

 

The posted derogatory depreciation reversal amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

accumulatedPostedDerogatoryDepreciationReversal

decimal

FixedAssetEvent Accumulated Posted Derogatory Depreciation Reversal

 

X

 

 

 

The accumulated posted derogatory depreciation reversal amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

postedRevaluationReversal

decimal

FixedAssetEvent Posted Revaluation Reversal

 

X

 

 

 

The posted revaluation reversal amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

accumultedPostedRevaluationReversal

decimal

FixedAssetEvent Accumulated Posted Revaluation Reversal

 

X

 

 

 

The accumulated posted revaluation reversal amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

postedImpairmentTransfer

decimal

FixedAssetEvent Posted Impairment Transfer

 

X

 

 

 

The posted impairment transfer amount associated with the Fixed Asset following the completion of the Fixed Asset Event.   In Fixed Asset Event Currency.  

notes

note*

FixedAssetEvent Note

 

X

 

 

child 

Notes associated with a Fixed Asset Event (e.g. credit control).    

Top  

Resource financialAccountJournal

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

FinancialAccountJournal Active Flag

 

 

 

 

 

Flag to indicate if the FinancialAccountJournal is an ‘active’ one .   Default = True  

reference

string

FinancialAccountJournal reference

X

X

 

 

 

Reference associated with the Financial Account Journal.    

reference2

string

FinancialAccountJournal Reference2

 

X

X

 

 

Another reference associated with the Financial Account Journal.    

type

string

FinancialAccountJournal Type

 

X

 

 

 

The type of the FinancialAccountJournal    

name

string

FinancialAccountJournal Name

 

X

 

X

 

The name of the FinancialAccountJournal (e.g. batch name)    

source

financialAccountJournalSource

FinancialAccountJournal Source

 

 

 

 

 

Source of the Financial Account Journal. E.g. this is the system module that triggered the Journal. 

sourceReference

string

FinancialAccountJournal source (module) reference

 

X

 

 

 

Source module reference associated with the Financial Account Journal.    

description

string

FinancialAccountJournal Description

 

X

 

 

 

A longer textual description of the FinancialAccountJournal.    

operatingCompany

operatingCompany

FinancialAccountJournal OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Financial Account Journal.   See “Company” definition (where Company Type = “Operating Company”).  

currency

string

FinancialAccountJournal Currency

 

 

 

 

 

The Financial Account Journal currency (e.g. GBP, USD, EUR).    

operatingCompanyCurrency

string

FinancialAccountJournal OperatingCompany Currency

 

X

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the “base” currency).    

operatingCompanyCurrencyExchangeRate

decimal

FinancialAccountJournal OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from FinancialAccountJournal Currency into FinancialAccountJournal OperatingCompany Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

financialAccountJournalOperatingCompanyCurrencyExchangeRateOperator

FinancialAccountJournal OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from FinancialAccountJournal Currency to FinancialAccountJournal OperatingCompany Currency.   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Operating Company Currency Exchange Rate = Sales Order Values in Sales Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

FinancialAccountJournal OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from FinancialAccountJournal Currency to FinancialAccountJournal OperatingCompany Currency, if different.   Default = System date  

creditSum

decimal

FinancialAccountJournal Credit Sum

 

 

 

 

 

Sum of all credits on the Journal Lines (sum of credits should equal sum of debits).   In Financial Account Journal currency.  

debitSum

decimal

FinancialAccountJournal Debit Sum

 

 

 

 

 

Sum of all debits on the Journal Lines (sum of debits should equal sum of credits).   In Financial Account Journal currency.  

lineCount

decimal

FinancialAccountJournal Line Count

 

 

 

 

 

Checksum/count of lines associated with the Financial Account Journal.   In Financial Account Journal currency.  

lines

financialAccountJournalLine*

FinancialAccountJournal Financial Account Journal Lines

 

 

 

 

child 

A link to all the lines making up the Financial Account Journal.   See “Financial Account Journal Lines” definition.  

entryDate

date

FinancialAccountJournal EntryDate

 

 

 

 

 

The date upon which the Journal was entered.   Default to system date if not used,  

postingDate

date

FinancialAccountJournal PostingDate

 

 

 

 

 

The date upon which the Journal was posted (if different).   Default to system date if not used,  

fixedAsset

fixedAsset*

FinancialAccountJournal FixedAsset

 

X

 

 

association 

A link to the Fixed Asset(s) associated with the Financial Account Journal.   See “Fixed Asset” definition.  

schedule

fixedAssetSchedule*

FinancialAccountJournal FixedAssetSchedule

 

X

 

 

association 

A link to the (depreciation) schedule associated with the Fixed Asset creating the Financial Account Journal.   See “FixedAssetSchedule” definition.  

opportunities

opportunity*

FinancialAccountJournal Opportunity

 

X

 

 

association 

Opportunities associated with the Financial Account Journal.   See “Opportunity” definition.  

salesQuotations

salesQuotation*

FinancialAccountJournal Sales Quotation

 

X

 

 

association 

Sales Quotation(s) associated with the Financial Account Journal.   See “SalesQuotation” definition.  

salesOrders

salesOrder*

FinancialAccountJournal Sales Order

 

X

 

 

association 

Sales Order(s) associated with the Financial Account Journal.   See “SalesOrder” definition.  

salesOrderDeliveries

salesOrderDelivery*

FinancialAccountJournal Sales Order Delivery

 

X

 

 

association 

Sales Order Delivery(s) associated with the Financial Account Journal.   See “SalesOrderDelivery” definition.  

salesInvoices

salesInvoice*

FinancialAccountJournal Sales Invoice

 

X

 

 

association 

Sales Invoice(s) associated with the Financial Account Journal.   See “SalesInvoice” definition.  

salesReturns

salesReturn*

FinancialAccountJournal Sales Return

 

X

 

 

association 

Sales Return(s) associated with the Financial Account Journal.   See “SalesReturn” definition.  

salesReturnDeliveries

salesReturnDelivery*

FinancialAccountJournal Sales Return Delivery

 

X

 

 

association 

Sales Return Delivery(s) associated with the Financial Account Journal.   See “SalesReturnDelivery” definition.  

salesCredits

salesCredit*

FinancialAccountJournal Sales Credit

 

X

 

 

association 

Sales Credit(s) associated with the Financial Account Journal.   See “SalesCredit” definition.  

purchaseRequistions

purchaseRequisition*

FinancialAccountJournal Purchase Requisition

 

X

 

 

association 

Purchase Requisition(s) associated with the Financial Account Journal.   See “PurchaseRequisition” definition.  

purchaseOrders

purchaseOrder*

FinancialAccountJournal Purchase Order

 

X

 

 

association 

Purchase Order(s) associated with the Financial Account Journal.   See “PurchaseOrder” definition.  

purchaseOrderDeliveries

purchaseOrderDelivery*

FinancialAccountJournal Purchase Order Delivery

 

X

 

 

association 

Purchase Order Delivery(s) associated with the Financial Account Journal.   See “PurchaseOrderDelivery” definition.  

purchaseInvoices

purchaseInvoice*

FinancialAccountJournal Purchase Invoice

 

X

 

 

association 

Purchase Invoice(s) associated with the Financial Account Journal.   See “PurchaseInvoice” definition.  

purchaseReturns

purchaseReturn*

FinancialAccountJournal Purchase Return

 

X

 

 

association 

Purchase Return(s) associated with the Financial Account Journal.   See “PurchaseReturn” definition.  

purchaseReturnDeliveries

purchaseReturnDelivery*

FinancialAccountJournal Purchase Return Delivery

 

X

 

 

association 

Purchase Return Delivery(s) associated with the Financial Account Journal.   See “PurchaseReturnDelivery” definition.  

purchaseCredits

purchaseCredit*

FinancialAccountJournal Purchase Credit

 

X

 

 

association 

Purchase Credit(s) associated with the Financial Account Journal.   See “PurchaseCredit” definition.  

receipts

receipt*

FinancialAccountJournal Receipt

 

X

 

 

association 

Receipt(s) associated with the Financial Account Journal.   See “Receipt” definition.  

payments

payment*

FinancialAccountJournal Payment

 

X

 

 

association 

Payment(s) associated with the Financial Account Journal.   See “Payment” definition.  

timesheets

timesheet*

FinancialAccountJournal Timesheets

 

X

 

 

association 

Link to the Timesheets associated with the Financial Account Journal.   See “Timesheet” definition.  

expenseClaims

expenseClaim*

FinancialAccountJournal ExpenseClaims

 

X

 

 

association 

Link to the Expense Claims associated with the Financial Account Journal.   See “Expense Claim” definition.  

payrolls

payroll*

FinancialAccountJournal Payroll

 

X

 

 

association 

Link to the Payrolls associated with the Financial Account Journal.   See “Payroll” definition.  

benefits

benefit*

FinancialAccountJournal Benefit

 

X

 

 

association 

Link to the (Employee) Benefits associated with the Financial Account Journal.   See “Benefit” definition.  

notes

note*

FinancialAccountJournal Note

 

X

 

 

child 

Note associated with the FinancialAccountJournal   See “Note” definition.  

Top  

Resource financialAccountJournalLine

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

journal

financialAccountJournal

FinancialAccountJournalLine Financial Account Journal

 

 

 

 

parent 

A link to the Financial Account Journal (batch) holding these lines.   See “Financial Account Journal” definition.  

active

boolean

FinancialAccountJournalLine Active Flag

 

 

 

 

 

Flag to indicate if the Financial Account Journal Line is an ‘active’ one .   Default = True  

reference

string

FinancialAccountJournalLine reference

X

X

 

 

 

Reference associated with the Financial Account Journal Line.    

reference2

string

FinancialAccountJournalLine Reference2

 

X

X

 

 

Another reference associated with the Financial Account Journal Line.    

sourceTransaction

financialAccountJournalLineSourceTransaction

FinancialAccountJournalLine Source Transaction

 

 

 

 

 

Source transaction of the Financial Account Journal Line. E.g. this is the transaction that triggered the Journal e.g. PL/AP Invoice etc. 

sourceReference

string

FinancialAccountJournalLine source (module) reference

 

X

 

 

 

Source module reference associated with the Financial Account Journal Line.    

type

financialAccountJournalLineType

FinancialAccountJournalLine Type

 

X

 

 

 

The type of the Financial Account Journal Line    

accountingType

financialAccountJournalLineAccountingType

FinancialAccountJournalLine Accounting Type

 

 

 

X

 

The accounting type of the Financial Account Journal Line (debit or credit)    

number

string

FinancialAccountJournalLine Number

 

X

 

 

 

The number of the Financial Account Journal Line (e.g. batch name)    

description

string

FinancialAccountJournalLine Description

 

X

 

 

 

A longer textual description of the Financial Account Journal Line.    

financialAccounts

financialAccount*

FinancialAccountJournalLine FinancialAccount

 

X

 

 

association 

Financial Account Journal Lineing code or ‘natural’ account.   See “Financial Account” definition.  

costCentres

costCentre*

FinancialAccountJournalLine CostCentre

 

X

 

 

association 

 

departments

department*

FinancialAccountJournalLine Departments

 

X

 

 

association 

 

amount

decimal

FinancialAccountJournalLine Amount

 

 

 

 

 

Financial Account Journal Line amount.   In Financial Account Journal currency.  

amountOperatingCompanyCurrency

decimal

FinancialAccountJournalLine Amount (Operating Company Currency)

 

 

 

 

 

Financial Account Journal Line amount.   In Financial Account Journal Operating Company (base/home) currency.  

statAmount

decimal

Financial Account Journal Statistical Amount

 

X

 

 

 

Financial account journal stat amount.   In financial account journal stat unit.  

statUnit

string

Financial Account Journal Statistical Unit

 

X

 

 

 

A text description of the statistical unit associated with this journal. Examples of stats include headcount, number of, etc. 

fixedAsset

fixedAsset*

FinancialAccountJournalLine FixedAsset

 

X

 

 

association 

A link to the Fixed Asset(s) associated with the Financial Account Journal Line.   See “Fixed Asset” definition.  

schedule

fixedAssetSchedule*

FinancialAccountJournalLine FixedAssetSchedule

 

X

 

 

association 

A link to the (depreciation) schedule associated with the Fixed Asset creating the Financial Account Journal Line.   See “FixedAssetSchedule” definition.  

opportunities

opportunity*

FinancialAccountJournalLine Opportunity

 

X

 

 

association 

Opportunities associated with the Financial Account Journal Line.   See “Opportunity” definition.  

salesQuotationLines

salesQuotationLine*

FinancialAccountJournalLine Sales Quotation Line

 

X

 

 

association 

Sales Quotation Line(s) associated with the Financial Account Journal Line.   See “SalesQuotationLine” definition.  

salesOrderLines

salesOrderLine*

FinancialAccountJournalLine Sales Order Line

 

X

 

 

association 

Sales Order Line(s) associated with the Financial Account Journal Line.   See “SalesOrderLines” definition.  

salesOrderDeliveryLines

salesOrderDeliveryLine*

FinancialAccountJournalLine Sales Order Delivery Line

 

X

 

 

association 

Sales Order Delivery Line(s) associated with the Financial Account Journal Line.   See “SalesOrderDeliveryLines” definition.  

salesInvoiceLines

salesInvoiceLine*

FinancialAccountJournalLine Sales Invoice Line

 

X

 

 

association 

Sales Invoice Line(s) associated with the Financial Account Journal Line.   See “SalesInvoiceLine” definition.  

salesReturnLines

salesReturnLine*

FinancialAccountJournalLine Sales Return Line

 

X

 

 

association 

Sales Return Line(s) associated with the Financial Account Journal Line.   See “SalesReturnLine” definition.  

salesReturnDeliveryLines

salesReturnDeliveryLine*

FinancialAccountJournalLine Sales Return Delivery Line

 

X

 

 

association 

Sales Return Delivery Line(s) associated with the Financial Account Journal Line.   See “SalesReturnDeliveryLine” definition.  

salesCreditLines

salesCreditLine*

FinancialAccountJournalLine Sales Credit Line

 

X

 

 

association 

Sales Credit Line(s) associated with the Financial Account Journal Line.   See “SalesCreditLine” definition.  

purchaseRequistionLines

purchaseRequisitionLine*

FinancialAccountJournalLine Purchase Requisition Line

 

X

 

 

association 

Purchase Requisition Line(s) associated with the Financial Account Journal Line.   See “PurchaseRequisitionLine” definition.  

purchaseOrderLines

purchaseOrderLine*

FinancialAccountJournalLine Purchase Order Line

 

X

 

 

association 

Purchase Order Line(s) associated with the Financial Account Journal Line.   See “PurchaseOrderLine” definition.  

purchaseOrderDeliveryLines

purchaseOrderDeliveryLine*

FinancialAccountJournalLine Purchase Order Delivery Line

 

X

 

 

association 

Purchase Order Delivery Line(s) associated with the Financial Account Journal Line.   See “PurchaseOrderDeliveryLine” definition.  

purchaseInvoiceLines

purchaseInvoiceLine*

FinancialAccountJournalLine Purchase Invoice Line

 

X

 

 

association 

Purchase Invoice Line(s) associated with the Financial Account Journal Line.   See “PurchaseInvoiceLine” definition.  

purchaseReturnLines

purchaseReturnLine*

FinancialAccountJournalLine Purchase Return Line

 

X

 

 

association 

Purchase Return Line(s) associated with the Financial Account Journal Line.   See “PurchaseReturnLine” definition.  

purchaseReturnDeliveryLines

purchaseReturnDeliveryLine*

FinancialAccountJournalLine Purchase Return Delivery Line

 

X

 

 

association 

Purchase Return Delivery Line(s) associated with the Financial Account Journal Line.   See “PurchaseReturnDeliveryLine” definition.  

purchaseCreditLines

purchaseCreditLine*

FinancialAccountJournalLine Purchase Credit Line

 

X

 

 

association 

Purchase Credit Line(s) associated with the Financial Account Journal Line.   See “PurchaseCreditLine” definition.  

receiptLines

receiptLine*

FinancialAccountJournalLine Receipt Line

 

X

 

 

association 

Receipt Line(s) associated with the Financial Account Journal Line.   See “ReceiptLine” definition.  

paymentLines

paymentLine*

FinancialAccountJournalLine Payment Line

 

X

 

 

association 

Payment Line(s) associated with the Financial Account Journal Line.   See “PaymentLine” definition.  

timesheetLines

timesheetLine*

FinancialAccountJournalLine TimesheetLines

 

X

 

 

association 

Link to the Timesheet Line(s) associated with the Financial Account Journal Line.   See “TimesheetLine” definition.  

expenseClaimLines

expenseClaimLine*

FinancialAccountJournalLine ExpenseClaimLines

 

X

 

 

association 

Link to the Expense Claim Line(s) associated with the Financial Account Journal Line.   See “Expense Claim Line” definition.  

payrollLines

payrollLine*

FinancialAccountJournalLine Payroll Line

 

X

 

 

association 

Link to the Payroll Line(s) associated with the Financial Account Journal Line.   See “PayrollLine” definition.  

benefits

benefit*

FinancialAccountJournalLine Benefit

 

X

 

 

association 

Link to the (Employee) Benefits associated with the Financial Account Journal Line.   See “Benefit” definition.  

notes

note*

FinancialAccountJournalLine Note

 

X

 

 

child 

Note associated with the Financial Account Journal Line   See “Note” definition.  

Top  

Resource lease

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Lease Active Flag

 

 

 

 

 

Flag to indicate if the Lease is an ‘active’ one .   Default = True  

reference

string

Lease Reference

X

 

 

 

 

Reference associated with the Lease.    

reference2

string

Lease Reference2

 

X

X

 

 

Another reference associated with the Lease.    

operatingCompany

operatingCompany

Lease OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the Lease.   See “Company” definition (where Company Type = “Operating Company”).  

text1

string

Lease Text1

 

X

 

 

 

Textual information associated with the Lease.    

text2

string

Lease Text2

 

X

 

 

 

Textual information associated with the Lease.    

status

leaseStatus

Lease Status

 

 

 

 

 

Status of the Lease.    

fixedAsset

fixedAsset*

Lease FixedAsset

 

X

 

 

association 

A link to the Fixed Asset(s) associated with the schedule.   See “Fixed Asset” definition.  

name

string

Lease Name

 

 

 

X

 

name of the lease    

description

string

Lease Description

 

X

 

 

 

Textual description of the Lease.    

type

string

Lease Type

 

X

 

 

 

The type of Lease (plan type for example).    

accountingType

string

Lease Accounting Type

 

X

 

 

 

The type of accounting used by the Lease, e.g. GAAP, IFRS, other    

typeOfContract

string

Lease Type of Contract

 

X

 

 

 

The type of contract associated with the Lease.    

tradingAccount

tradingAccount

Lease TradingAccount

 

X

X

 

reference 

Link to the Trading Account that will be the deliverer of the Lease.   See “TradingAccount” definition. (CRM schema).  

supplierReference

string

Lease Supplier Reference

 

X

 

 

 

Reference for the Lease as used by the Supplier.    

originatorDocument

purchaseInvoice

Lease Originator Document Reference

 

X

 

 

reference 

Reference to another document (e.g. the purchase order or purchase Invoice associated with the supplier).   See “PurchaseOrder” or “PurchaseInvoice” definition. (CRM schema).  

origin

leaseOrigin

Lease Origin

 

X

 

 

 

The origin of the Lease.    

duration

decimal

Lease Duration

 

X

 

 

 

The Actual/planned duration of the Lease, in duration unit.    

durationUnit

leaseDurationUnit

Lease Duration Unit

 

X

 

 

 

The unit used for duration.    

year

decimal

Lease Year

 

X

 

 

 

Year associate with the Lease (where a schedule spans multiple years there will be multiple Leases)    

period

string

Lease Period

 

X

 

 

 

Period associate with the Lease    

leaseStartDate

date

Lease Start Date

 

X

 

 

 

A start date associated with the Lease(if applicable).    

leaseSupplierEndDate

date

Lease Supplier End Date

 

X

 

 

 

An end date driven by the Supplier associated with the Lease (if applicable).    

electiveSupplierEndDate

date

Lease Elective End Date

 

X

 

 

 

The end date driven by the Operating Company associated with the Lease (if applicable).    

reviewDate

date

Lease Review Date

 

X

 

 

 

The review date associated with the Lease (if applicable).    

natureOfContract

string

Lease Nature of Contract

 

X

 

 

 

The nature of the contract associated with the Lease.    

financialAccountGroup

financialAccountGroup*

Lease FinancialAccountGroup

 

X

 

 

association 

Link to the Financial Account Group associated with this Lease.   See “Financial Account Group” definition.  

financialAccounts

financialAccount*

Lease FinancialAccount

 

X

 

 

association 

Financial accounting code(s) applicable to the Lease.   See “FinancialAccount” definition (CRM schema).  

costCentres

costCentre*

Lease CostCentre

 

X

 

 

association 

 

departments

department*

Lease Departments

 

X

 

 

association 

 

currency

string

Lease Currency

 

X

 

 

 

The currency of the Lease (e.g. GBP, USD, EUR).    

operatingCompanyCurrency

string

Lease OperatingCompany Currency

 

X

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the “base” currency).    

operatingCompanyCurrencyExchangeRate

decimal

Lease OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Lease Currency into Lease OperatingCompany Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

leaseOperatingCompanyCurrencyExchangeRateOperator

Lease OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Lease Currency to Lease OperatingCompany Currency.   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Operating Company Currency Exchange Rate = Sales Order Values in Sales Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Lease OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Lease Currency to Lease OperatingCompany Currency, if different.   Default = System date  

supplierTradingAccountCurrency

string

Lease Supplier TradingAccount Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Supplier Trading Account on the Lease.   ISO 4217. Could be derived from order currency.  

supplierTradingAccountCurrencyExchangeRate

decimal

Lease Supplier TradingAccount Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Lease currency into the Supplier Trading Account currency, if different.    

supplierTradingAccountCurrencyExchangeRateOperator

leaseSupplierTradingAccountCurrencyExchangeRateOperator

Lease Supplier TradingAccount Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Lease Currency to Lease Supplier Trading Account Currency   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Lease Values in Lease Currency / Lease Supplier TradingAccount Currency Exchange Rate = Lease Values in Lease Supplier TradingAccount Currency.  

supplierTradingAccountCurrencyExchangeRateDate

date

Lease Supplier TradingAccount Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Lease Currency to Supplier Trading Account Currency, if different.   Default = System date  

isCurrent

boolean

Lease Is Current Flag

 

X

 

 

 

Flag to indicate if this Lease is the current on.    

previousLease

lease

Lease Previous Lease

 

X

 

 

reference 

A link to a previous Lease that this Lease is related to (e.g. for renewals, this will point to the schedule for the previous year).    

associatedChildLease

lease*

Lease Associated Child Lease

 

X

 

 

child 

Link to Child Lease associated with this Lease.   Leases can be ‘nested’ to create Lease hierarchies (e.g. a parent lease could be for a year, whereas the child lease could be for individual periods).  

associatedParentLease

lease

Lease Associated Parent Lease

 

X

 

 

parent 

Link to Parent Lease associated with this Lease.   Leases can be ‘nested’ to create Lease hierarchies (e.g. a parent lease could be for a year, whereas the child lease could be for individual periods).  

initialContractValue

decimal

Lease Initial Contract Value

 

X

 

 

 

The initial contract value of the Lease.   Lease Currency.  

contractValueStart

decimal

Lease Contract Value Start

 

X

 

 

 

The contract value of the Lease as at the start of the lease (e.g. start of year).   Lease Currency.  

ContractValueCurrent

decimal

Lease Contract Value Current

 

X

 

 

 

The current Contract value of the Lease.   Lease Currency.  

ContractValueEnd

decimal

Lease Contract Value End

 

X

 

 

 

The Contract value of the Lease as at the end of the lease (e.g. end of year).   Lease Currency.  

finalContractRepaymentValue

decimal

Lease Final Contract Repayment Value

 

X

 

 

 

The amount that will still be outstanding at the end of the lease (balloon amount or residual payment).   Lease Currency.  

capitalValueStart

decimal

Lease Capital Value Start

 

X

 

 

 

The Capital value outstanding on the Lease as at the start of the lease (e.g. start of year).   Lease Currency.  

capitalValueCurrent

decimal

Lease Capital Value Current

 

X

 

 

 

The current Capital value outstanding on the Lease.   Lease Currency.  

capitalValueEnd

decimal

Lease Capital Value End

 

X

 

 

 

The Capital value outstanding on the Lease as at the end of the lease (e.g. end of year).   Lease Currency.  

lastPayment

decimal

Lease Last Repayment

 

X

 

 

 

Last payment made against the lease.   Lease Currency.  

lastPaymentDate

date

Lease Last Repayment Date

 

X

 

 

 

Date the last payment was made against the lease.    

cumulativePayment

decimal

Lease Cumulative Payment

 

X

 

 

 

The cumulative value of all the payments made against the Lease.   Lease Currency.  

lastCapitalPayment

decimal

Lease Last Capital Repayment

 

X

 

 

 

Last capital payment made against the lease.   Lease Currency.  

cumulativeCapitalPayment

decimal

Lease Cumulative Capital Payment

 

X

 

 

 

The cumulative value of the capital payments made against the Lease.   Lease Currency.  

lastFinancePayment

decimal

Lease Last Finance Repayment

 

X

 

 

 

Last Finance payment made against the lease.   Lease Currency.  

cumulativeFinancePayment

decimal

Lease Cumulative Finance Payment

 

X

 

 

 

The cumulative value of the Finance payments made against the Lease.   Lease Currency.  

lastDepreciationExpense

decimal

Lease Last Depreciation Expense

 

X

 

 

 

Last depreciation amount financial expense (charge).   Lease Currency.  

cumulativeDepreciationExpense

decimal

Lease Cumulative Depreciation Expense

 

X

 

 

 

The cumulative value of the depreciation amount financial expense (charge).   Lease Currency.  

fixedAssetEvents

fixedAssetEvent*

Lease Fixed Asset Events

 

X

 

 

association 

A link to all of the Fixed Asset Events associated with the Lease.   See “Fixed Asset Event” definition.  

notes

note*

Lease Note

 

X

 

 

child 

Notes associated with the Lease    

Top  

Resource grant

Name

Type

Label

Unique

Nillable

Extension

Mandatory

Relationship

Documentation

active

boolean

Grant Active Flag

 

 

 

 

 

Flag to indicate if the Grant is an ‘active’ one .   Default = True  

reference

string

Grant reference

X

X

 

 

 

reference associated with the Grant.    

reference2

string

Grant Reference2

 

X

X

 

 

Another reference associated with the Grant.    

operatingCompany

operatingCompany

Grant OperatingCompany

 

 

 

 

reference 

Link to the OperatingCompany associated with the grant.   See “Company” definition (where Company Type = “Operating Company”).  

type

string

Grant Type

 

X

 

 

 

The type of the Grant    

name

string

Grant Name

 

 

 

X

 

Name of the Grant    

text1

string

Grant Text1

 

X

 

 

 

Textual information associated with the Grant.    

text2

string

Grant Text2

 

X

 

 

 

Textual information associated with the Grant.    

status

string

Grant Status

 

X

X

 

 

Status of the Grant.    

fixedAssets

fixedAsset*

Grant FixedAsset

 

X

 

 

association 

A link to the Fixed Assets associated with the Grant.   See “Fixed Asset” definition.  

fixedAssetEvents

fixedAssetEvent*

Grant Fixed Asset Events

 

X

 

 

association 

A link to all of the Fixed Asset Events associated with the Grant.   See “Fixed Asset Event” definition.  

grantingCompany

operatingCompany*

Grant Granting Company

 

X

 

 

association 

A link to the Company that provides the Grant (the Grantor).   See “Compy” definition (CRM schema).  

dateOfApproval

date

Grant Date of Approval

 

X

 

 

 

The date the Grant was approved.    

percentageCovered

decimal

Grant Percentage Covered

 

X

 

 

 

Value indicating the percentage of associated investment (Fixed Asset, Project) that is covered by the Grant.    

currency

string

Grant Currency

 

X

 

 

 

The currency of the Grant (e.g. GBP, USD, EUR).    

operatingCompanyCurrency

string

Grant OperatingCompany Currency

 

X

 

 

 

The currency as used by OperatingCompany, the business operating the Sage application (the “base” currency).    

operatingCompanyCurrencyExchangeRate

decimal

Grant OperatingCompany Currency Exchange Rate

 

X

 

 

 

Rate used to convert from Grant Currency into Grant OperatingCompany Currency, if different.    

operatingCompanyCurrencyExchangeRateOperator

grantOperatingCompanyCurrencyExchangeRateOperator

Grant OperatingCompany Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Grant Currency to Grant OperatingCompany Currency.   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Sales Order Values in Sales Order Currency / Sales Order Operating Company Currency Exchange Rate = Sales Order Values in Sales Order OperatingCompany currency.  

operatingCompanyCurrencyExchangeRateDate

date

Grant OperatingCompany Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Grant Currency to Grant OperatingCompany Currency, if different.   Default = System date  

CompanyCurrency

string

Grant Company Currency

 

X

 

 

 

The currency (e.g. GBP, USD, EUR) used by the Company on the Grant.   ISO 4217. Could be derived from order currency.  

CompanyCurrencyExchangeRate

decimal

Grant Company Currency Exchange Rate

 

X

 

 

 

Rate used to convert the Grant currency into the Company currency, if different.    

CompanyCurrencyExchangeRateOperator

grantCompanyCurrencyExchangeRateOperator

Grant Company Currency Exchange Rate Operator

 

X

 

 

 

Operator to be used (multiplication or division) to convert from Grant Currency to Grant Company Currency   “*” (multiplication) or “/” division. E.g. if the operator is division then it is Grant Values in Grant Currency / Grant Company Currency Exchange Rate = Grant Values in Grant Company Currency.  

CompanyCurrencyExchangeRateDate

date

Grant Company Currency Exchange Rate Date

 

X

 

 

 

Date of the exchange rate used to convert from Grant Currency to Company Currency, if different.   Default = System date  

fixedValue

decimal

Grant Fixed Value

 

X

 

 

 

Some Grants may be for a fixed value. Where this is the case, this is the value associated with the Grant.   In Grant currency  

maximumValue

decimal

Grant Maximum Value

 

X

 

 

 

Some Grants may be drawn down in parts (or received) up to a maximum value (e.g. a facility). Where this is the case, this is the maximum possible value of the Grant.   In Grant currency  

currentValue

decimal

Grant Current Value

 

X

 

 

 

Some Grants may be drawn down in parts (or received) up to a maximum value (e.g. a facility). Where this is the case, this is the amount of the Grant currently taken.   In Grant currency  

availableValue

decimal

Grant Value Available

 

X

 

 

 

Some Grants may be drawn down in parts (or received) up to a maximum value (e.g. a facility). Where this is the case, this is the remaining amount of the Grant that may be taken.   In Grant currency  

lastDepreciationExpense

decimal

Grant Last Depreciation Expense

 

X

 

 

 

Last depreciation amount financial expense (charge).   Grant Currency.  

cumulativeDepreciationExpense

decimal

Grant Cumulative Depreciation Expense

 

X

 

 

 

The cumulative value of the depreciation amount financial expense (charge).   Grant Currency.  

project

project

Grant Project

 

X

 

 

reference 

A link to any Project that may be associated with the Grant.   See “Project” definition (CRM schema).  

projectAmount

decimal

Grant Project Amount

 

X

 

 

 

For Grants directly attributable to Projects, this is the amount of the Grant that has been allocated to the Project.    

receipts

receipt*

Grant Receipts

 

X

 

 

association 

A link to any (cash) receipts associated with the Grant.   See “Receipt” definition (CRM schema).  

notes

note

Grant Note

 

X

 

 

child 

Note associated with the Grant   See “Note” definition.  

Top  

Enumeration operatingCompanyLegalEntityType

Sole Trader

Partnership

Limited Liability Partnership

Limited Company

Public Limited Company

User Defined

Other

Unknown

Top  

Enumeration postalAddressType

Shipping

Billing

Correspondence

Home

Office

Work Site

Other

Unknown

Top  

Enumeration phoneNumberType

Business Phone

Business Fax

Business Mobile

Personal Phone

Personal Fax

Personal Mobile

Pager

Toll Free

Other Phone

Other Fax

Unknown

Top  

Enumeration emailType

Business

Personal

Other

Unknown

Top  

Enumeration financialAccountPostingType

Memo

Posting

Grouping

Unknown

Top  

Enumeration financialAccountReportingType

Profit & Loss

Balance Sheet

User Defined

Unknown

Top  

Enumeration financialAccountAccountingType

Revenue

Expense

Revenue & Expense

User Defined

Unknown

Top  

Enumeration financialAccountAnalysisType

Natural

Other

Top  

Enumeration financialAccountNaturalBalanceType

Debit

Credit

Top  

Enumeration financialAccountAccountType

Cash (Default)

Cash (Cash Equivalents)

Accounts Receivable

Other Receivables (Default)

Other Receivables (Long Term)

Inventory

Prepaid Expenses (Prepayments/Credit Cards)

Prepaid Expenses (Default)

Other Assets (Bank)

Other Assets (VAT/Sales Tax)

Other Assets (Default)

Fixed Assets (Default)

Fixed Assets (Buildings)

Fixed Assets (Land)

Fixed Assets (Lease)

Fixed Assets (Plant/Machinery)

Fixed Assets (Equipment)

Fixed Assets (Fixtures/Furniture)

Fixed Assets (Vehicles)

Current Liabilities (Creditors/Accounts Payable)

Current Liabilities (Wages/Payroll)

Current Liabilities (Accruals/Credit Cards)

Current Liabilities (Bank/Cash on hand/Securities)

Current Liabilities (Default)

Current Liabilities (VAT/Sales Tax)

Current Liabilities (Dividends)

Long Term Liabilities (Default)

Stockholders Equity

Retained Earnings

Sales (Default)

Sales (Asset Sales)

Sales (Finance/Interest)

Sales (Default)

Cost Of Goods Sold (Labour)

Cost Of Goods Sold (Subcontractors)

Cost Of Goods Sold (Commodities)

Cost Of Goods Sold (Materials)

Cost Of Goods Sold (Default)

Other Income and Expense (Wages/Payroll)

Other Income and Expense (Rent/Rates)

Other Income and Expense (Office)

Other Income and Expense (Heat/Light/Power)

Other Income and Expense (Vehicles)

Other Income and Expense (Travel)

Other Income and Expense (IT)

Other Income and Expense (Professional)

Other Income and Expense (Hire/Rental)

Other Income and Expense (Maintenance)

Other Income and Expense (Depreciation/Amortisation)

Other Income and Expense (Bad Debts)

Other Income and Expense (Default)

Other Income and Expense (Suspense)

Other Income and Expense (Finance/Interest)

Income Tax (Default)

Income Tax (Payroll)

Income Tax (Corporation/Company)

Operating Expense (Accounts Payable)

Operating Expense (Inventory)

Operating Expense (Default)

Non Financial

Top  

Enumeration financialAccountAccountCategory

Asset (Fixed Assets)

Asset (Current Assets)

Liability (Current Liabilities)

Liability (Long Term Liabilities)

Equity (Capital and Reserves)

Revenue (Sales)

Cost Of Sales (Direct Expenses)

Other Income and Expense (Overheads)

Income Tax

Expense (Purchases)

Non Financial

Top  

Enumeration financialAccountCurrencyRestriction

Base Currency Only

Base Currency + One Other Currency

All Currencies

Top  

Enumeration rateOperator

*

/

Top  

Enumeration financialPeriodStatus

Open

Closed

Top  

Enumeration financialBudgetStatus

Active

Hold

Closed

Top  

Enumeration financialAccountGroupType

Layout

Category

Unknown

Other

Top  

Enumeration financialPeriodType

Year

Quarter

Period

Month

Week

Day

User Defined

Top  

Enumeration tradingAccountType

Direct Sales/Cash

On Account

Subcontract

Unknown

Top  

Enumeration discountType

Percent

Amount

Both

Top  

Enumeration tradingAccountAccountingType

Cash

Open Item

Balance Forward

Unknown

Top  

Enumeration contactGender

Male

Female

Not Specified

Top  

Enumeration contactCompanyContext

Employee

Owner

Officer

Subcontractor

Agent

Other

Unknown

Top  

Enumeration salesOrderStatus

Entered

Ordered/Confirmed

Changed

Part-Delivered

Delivered

Part-Invoiced

Invoiced

Cancelled

Top  

Enumeration salesOrderAllocationStatus

None

Partial

Full

Top  

Enumeration salesOrderInvoiceStatus

None

Partial

Full

Top  

Enumeration lineType

Standard Line

Free Text

Commentary

Component

Discount/Charge

Top  

Enumeration salesQuotationStatus

Entered

Confirmed

Ordered

Cancelled

Top  

Enumeration commodityCommodityIdentifierType

Total

Batch/Lot

Serial

Serial From Batch/Lot

Unknown

Top  

Enumeration commodityType

Product Stock

Product Non Stock

Service

Bill Of Material

Kit

Subcontract

Description

User Defined

Unknown

Top  

Enumeration commodityCommissionType

Percent

Amount

Both

Top  

Enumeration commodityGroupType

Product Stock

Product Non Stock

Service

Bill Of Material

Kit

Subcontract

Description

User Defined

Unknown

Top  

Enumeration priceListType

Selling

Buying

Buying & Selling

Other

Top  

Enumeration priceListCalculationType

Percent

Amount

Both

Top  

Enumeration opportunityStatus

Open

Won

Lost

In Progress

Top  

Enumeration opportunityPriority

High

Medium

Low

Top  

Enumeration opportunityProbabilityIndicatorType

Percent

String

Top  

Enumeration interactionType

Internal Meeting

External Meeting

Outbound Email

Inbound Email

Outbound Phone Call

Inbound Phone Call

To Do

Inbound Letter

Outbound Letter

Memorandum

Unknown

Top  

Enumeration interactionStatus

Complete

In Progress

Top  

Enumeration interactionPriority

High

Medium

Low

Top  

Enumeration interactionRecurrenceFrequency

Daily

Weekly

Biweekly

Four Weekly

Monthly

Biannual

Yearly

Top  

Enumeration salesInvoiceStatus

Written

Printed

Cancelled

Top  

Enumeration salesInvoiceAllocationStatus

None

Partial

Full

Top  

Enumeration salesInvoiceDeliveryStatus

None

Partial

Full

Top  

Enumeration salesInvoiceType

Pro-forma

Normal

Top  

Enumeration salesCreditStatus

Written

Printed

Cancelled

Top  

Enumeration salesCreditType

Pro-forma

Normal

Top  

Enumeration salesReturnStatus

Entered

Returned/Confirmed

Changed

Part-Received

Received

Credited

Cancelled

Top  

Enumeration salesOrderDeliveryStatus

None

Partial

Full

Top  

Enumeration salesOrderDeliveryLineStatus

Entered

Confirmed

Changed

Part-Delivered

Delivered

Part-Invoiced

Invoiced

Cancelled

Top  

Enumeration salesReturnDeliveryStatus

Entered

Confirmed

Changed

Part-Received

Received

Part-Credited

Credited

Cancelled

Top  

Enumeration purchaseInvoiceLineStatus

Written

Printed

Cancelled

Top  

Enumeration purchaseOrderStatus

Entered

Ordered/Confirmed

Changed

Part-Received

Received

Part-Invoiced

Invoiced

Cancelled

Top  

Enumeration purchaseRequisitionStatus

Entered

Confirmed

Ordered

Cancelled

Top  

Enumeration purchaseRequisitionLineStatus

Entered

Ordered/Confirmed

Cancelled

Top  

Enumeration purchaseInvoiceStatus

Written

Printed

Cancelled

Top  

Enumeration purchaseCreditStatus

Written

Printed

Cancelled

Top  

Enumeration purchaseReturnStatus

Entered

Returned/Confirmed

Changed

Part-Delivered

Delivered

Part-Credited

Credited

Cancelled

Top  

Enumeration purchaseOrderDeliveryStatus

Entered

Confirmed

Changed

Part-Received

Received

Invoiced

Cancelled

Top  

Enumeration purchaseReturnDeliveryStatus

Entered

Confirmed

Changed

Part-Delivered

Delivered

Credited

Cancelled

Top  

Enumeration projectLineAccountingType

Revenue

Expense

Unknown

Top  

Enumeration supplierFlag

Customer

Supplier

Both

Neither

Unknown

Top  

Enumeration tradingAccountPersonFlag

Company

Person

Top  

Enumeration commodityIdentifierType

Total

Batch/Lot

Serial

Top  

Enumeration salesPersonCommissionType

Percent

Amount

Both

Top  

Enumeration commodityDimensionType

Height

Width

Depth

Volume

Area

User Defined

Unknown

Top  

Enumeration commodityVariantType

Colour

Size

Width

User Defined

Unknown

Top  

Enumeration caseStatus

Open

Closed

Top  

Enumeration casePriority

High

Medium

Low

Top  

Enumeration priceChangeStatusType

No Change

Price Up

Price Down

Top  

Enumeration positionStatus

Vacant

Occupied

Redundant

Retired

Planned

Unknown

Top  

Enumeration positionType

Full Time

Part Time

Casual/Temp

Contractor

Student/Intern

Work Placement

Unknown

Top  

Enumeration vacancyStatus

Available

Advertised

Interviewed

Waiting

Appointed

Unknown

Top  

Enumeration vacancyType

Full Time

Part Time

Casual/Temp

Contractor

Student

Unknown

Top  

Enumeration employeeGender

Male

Female

Not Specified

Unknown

Top  

Enumeration employeeTaxClass

0

1

Top  

Enumeration employeeNoticeUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employeeEmployerNoticeUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employeeNoticeGivenBy

Employee

Employer

Unknown

Top  

Enumeration employeeProbationUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentStatus

Employed

Leaver

Career Break

Maternity/Paternity

Absence

Sickness

Unknown

Top  

Enumeration employmentType

Full Time

Part Time

Unknown

Top  

Enumeration employmentWorkType

Permanent

Casual

Homeworker

Secondment Expatrie

Maternity Cover

Student Intern

Other

Unknown

Top  

Enumeration employmentDurationUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Pieces

Unknown

Top  

Enumeration employmentNoticeUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentEmployerNoticeUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentNoticeGivenBy

Employee

Employer

Unknown

Top  

Enumeration employmentProbationUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentJobType

Director

Manager

Supervisor

Team Leader

Operative

Top  

Enumeration employmentPayrollType

Unpaid Voluntary

Hourly

Salaried

Unit-based

Emolument Director

Contract

User defined

Other

Unknown

Top  

Enumeration employmentPayrollPaymentMethod

Cash

Cheque

Electronic

Unknown

Top  

Enumeration employmentPayrollPayFrequency

Daily

Weekly

Fortnightly/Bi-Weekly

Four Weekly

Monthly

Quarterly

Annually

Irregular

Unknown

Top  

Enumeration employmentOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration employmentPayrollSalaryPer

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentWorkObligationPer

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentMaximumWorkPer

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentHolidayEntitlementPer

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentSicknessEntitlementPer

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration employmentAbsenceEntitlementPer

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration competencyStatus

Achieved

Objective

Reference

Unknown

Top  

Enumeration competencyType

Academic

Professional

Work/Employment

Personal

Language

Unknown

Top  

Enumeration competencyDurationUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration competencyGroupType

Academic

Professional/

Certification

Work/Employment

Personal

Language

Unknown

Top  

Enumeration competencyGroupLevelNumberSort

Ascending

Descending

Top  

Enumeration resumeType

Actual

Application

Unknown

Top  

Enumeration timesheetStatus

Draft

Submitted

Authorised

Rejected

Posted

Closed

Top  

Enumeration timesheetOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration timesheetUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Piece

Unknown

Top  

Enumeration timesheetLineTimeType

Work

Absence

Unknown

Top  

Enumeration timesheetLineStatus

Draft

Submitted

Authorised

Rejected

Posted

Closed

Top  

Enumeration timesheetLineUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Piece

Unknown

Top  

Enumeration expenseClaimStatus

Draft

Submitted

Authorised

Rejected

Posted

Closed

Top  

Enumeration expenseClaimOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration expenseClaimLineUnit

Mile

Kilometer

Night

Day

Miscellaneous Unit

Unknown

Top  

Enumeration benefitStatus

Live

Completed

Expired

Unknown

Top  

Enumeration benefitType

Bonus

Pension

Medical Insurance

Travel Insurance

Dental Insurance

Pet Insurance

Sickness Insurance

Life Insurance

Holiday/Vacation

Vehicle – asset provided

Vehicle – cash allowance

Stock

Sports/Social

Finance/Loan

Fuel Card

Clothing

Other Asset

Unknown

Top  

Enumeration benefitSuperType

Benefit

Deduction

Top  

Enumeration benefitFrequency

Daily

Weekly

Fortnightly/Bi-Weekly

Four Weekly

Monthly

Quarterly

Annually

Irregular

Unknown

Top  

Enumeration benefitDeliveryMethod

Payroll

Other

Unknown

Top  

Enumeration benefitUnit

Hours

Days

Weeks

Months

Years

Monetary

Percentage

Unknown

Top  

Enumeration benefitOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration vehicleOwnership

Company

Private

Unknown

Top  

Enumeration vehicleStatus

Individual

Pool

Unknown

Top  

Enumeration vehicleType

Car

Van

Motorcycle

Bicycle

Unknown

Top  

Enumeration vehicleTaxationTypeIndicator

CO2

HP

Other

Exempt

Unknown

Top  

Enumeration payrollPaymentMethod

Cash

Cheque

Electronic

Unknown

Top  

Enumeration payrollPayFrequency

Daily

Weekly

Fortnightly/Bi-Weekly

Four Weekly

Monthly

Quarterly

Annually

Irregular

Unknown

Top  

Enumeration payrollWorkUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration payrollSalaryUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration payrollLineType

Salary

Tax

Benefit

Deduction

Expense

Memorandum

Top  

Enumeration payrollLineWorkUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration payrollLineSalaryUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Pieces

Unknown

Top  

Enumeration payslipPaymentMethod

Cash

Cheque

Electronic

Unknown

Top  

Enumeration payslipPayFrequency

Daily

Weekly

Fortnightly/Bi-Weekly

Four Weekly

Monthly

Quarterly

Annually

Irregular

Unknown

Top  

Enumeration payslipWorkUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration payslipSalaryUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration payslipLineType

Salary

Tax

Benefit

Deduction

Expense

Memorandum

Top  

Enumeration payslipLineWorkUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration payslipLineSalaryUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Pieces

Unknown

Top  

Enumeration objectiveStatus

Draft

Set

Appraised

Continuous

Unknown

Top  

Enumeration objectiveAppraisalFrequency

Annual

Bi-Annual

Quarterly

Weekly

Fortnightly/Bi-Weekly

Monthly

Bi-Monthly

Interim

Unknown

Top  

Enumeration appraisalStatus

Requested/ Pending

Acknowledged

Declined

Scheduled

In Progress

Completed

Reviewed

Filed

Unknown

Top  

Enumeration appraisalFrequency

Annual

Bi-Annual

Quarterly

Weekly

Fortnightly/Bi-Weekly

Monthly

Bi-Monthly

Interim

Unknown

Top  

Enumeration appraisalType

Self

Peer

Manager

Project

360

Other

Unknown

Top  

Enumeration disciplinaryStage

Informal

Caution

Verbal Warning

Written Warning

Dismissal

Unknown

Top  

Enumeration disciplinaryStatus

Proposed

Current

Expired

Unknown

Top  

Enumeration incidentType

Accident

Sickness

Absence

Theft

Damage

Dishonesty

Fraud

Misappropriation

Technology

User Defined

Other

Unknown

Top  

Enumeration incidentStatus

Reported

Acknowledged

Completed

Reviewed

Filed

Unknown

Top  

Enumeration trainingCategory

Internal

External

Unknown

Top  

Enumeration trainingSessionUnit

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration trainingDeliveryMethod

Class

Research

Job-based

Seminar

One-to-one

Self study

Unknown

Top  

Enumeration trainingClawbackPeriodUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration trainingEventStatus

Planned

Delivered

Deferred

Cancelled

Unknown

Top  

Enumeration trainingEventDeliveryMethod

Class

Research

Job-based

Seminar

One-to-one

Self study

Top  

Enumeration trainingRegisterStatus

Applied

Confirmed

Reserve

Rejected

Cancelled

Deferred

Unknown

Top  

Enumeration workTimeLineValue

Working

Non-Working

Top  

Enumeration absenceReason

Holidays

Public Holiday

Sickness

Adoption

Jury Service Compassionate

Custodial

Maternity

Paternity

Study

Earned Holiday TOIL

Trade

Career Break

Armed Forces

Unknown

Top  

Enumeration absenceUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration absenceWorkUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Unknown

Top  

Enumeration absenceLineReason

Holidays

Public Holiday

Sickness

Adoption

Jury Service Compassionate

Custodial

Maternity

Paternity

Parental

Study

Earned Holiday TOIL

Trade

Career Break

Armed Forces

Allowable

Unknown

Top  

Enumeration absenceLineTimeOfDateIndicator

AM

PM

Full Day

Unknown

Top  

Enumeration relatedPartyPersonalRelationship

Spouse

Child

Parent

Other Dependent

Next of Kin

None

Unknown

Top  

Enumeration relatedPartyGender

Male

Female

Not Specified

Unknown

Top  

Enumeration payrollElementType

Standard

Overtime

Variable

Other

Unknown

Top  

Enumeration payrollElementAbsenceCategory

Sickness

Holiday

Absence

Non-Absence

Top  

Enumeration expenseCategoryUnit

Mile

Kilometer

Night

Day

Miscellaneous Unit

Unknown

Top  

Enumeration rateType

Cost

Charge Billing

Pay

Other

Unknown

Top  

Enumeration rateUnit

Second

Minute

Hour

Day

Week

Fortnight/Bi-Weekly

Four Weeks

Month

Quarter

Year

Piece

Unknown

Top  

Enumeration percentAmount

Percent

Amount

Top  

Enumeration fixedAssetOwnershipStatus

Planned

Actual

Unknown

Top  

Enumeration fixedAssetHoldingTerms

Property

Lease

Concession

Budget

User defined

Unknown

Top  

Enumeration fixedAssetAssetType

Tangible

Intangible

Goodwill

Financial

Top  

Enumeration fixedAssetPermanence

Fixed

Mobile

Installation

Other

Unknown

Top  

Enumeration fixedAssetLegalTaxRecoveryFlag

Recoverable

Non-Recoverable

Top  

Enumeration fixedAssetOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration fixedAssetAcquisitionType

Purchase

Merger

Production

Split

Intra Group Sale

Lease buyback

User defined

Unknown

Top  

Enumeration fixedAssetPurchaseType

New

Used

Unknown

Top  

Enumeration fixedAssetBusinessUseUnit

Amount

Percent

Unit

Top  

Enumeration fixedAssetGroupType

Family

User Defined

FAA

FAI

Other

Unknown

Top  

Enumeration fixedAssetScheduleType

Accounting

Tax

Other

Unknown

Top  

Enumeration fixedAssetScheduleStatus

Planned

Ongoing (Current)

Complete

Suspended

Unknown

Top  

Enumeration fixedAssetScheduleDurationUnit

Minute

Day

Week

Month

Quarter

Year

Unknown

Top  

Enumeration fixedAssetScheduleDepreciationMethod

Straight Line

Declining Balance

Activity Based

Sum Of Years

Units Of Production

Units Of Time

User Defined

Other

None

Unknown

Top  

Enumeration fixedAssetScheduleOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration fixedAssetScheduleDepreciationRateType

Amount

Percent

Unit

Top  

Enumeration fixedAssetEventStatus

Posted

Non-posted

Unknown

Top  

Enumeration fixedAssetEventAssetLeaseGrantFlag

Fixed Asset

Lease

Grant

Top  

Enumeration fixedAssetEventType

Fixed Asset Creation

Fixed Asset Update

Fixed Asset Transfer

Fixed Asset Depreciation Charge

Fixed Asset Changed Account

Fixed Asset Deletion

Fixed Asset Sale

Fixed Asset Disposal

Fixed Asset Impairment

Fixed Asset Revaluation

Fixed Asset Changed Method

Fixed Asset Changed Taxation

Lease Payment

Lease Purchase Option

Lease Cancelation

Lease End of lease

Grant Creation

Grant Payment

Grant Re-instatement

Unknown

Top  

Enumeration fixedAssetEventOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration fixedAssetEventProportionUnit

Amount

Percent

Unit

Top  

Enumeration financialAccountJournalOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration financialAccountJournalLineType

Accounting

IAS

Top  

Enumeration financialAccountJournalLineAccountingType

Debit

Credit

Top  

Enumeration leaseStatus

Planned

Ongoing

Complete

Suspended

Unknown

Top  

Enumeration leaseOrigin

New

Renewal

Unknown

Top  

Enumeration leaseDurationUnit

Minute

Day

Week

Month

Quarter

Year

Unknown

Top  

Enumeration leaseOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration leaseSupplierTradingAccountCurrencyExchangeRateOperator

*

/

Top  

Enumeration grantOperatingCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration grantCompanyCurrencyExchangeRateOperator

*

/

Top  

Enumeration financialAccountJournalSource

Nominal/General Ledger

Purchase Ledger/Accounts Payable

Purchase Order

Sales Ledger/Accounts Receivable

Sales Order

Invoicing

Cash/Bank Management

Stock/Inventory Control

Payroll

Manufacturing

Project/Job Accounting

Warehouse

Point Of Sale/Retail

Consolidation

Timesheet

Intercompany

Tax

Fixed Assets

Bill of Materials

Pricing

Import

Not Specified

Treasury

Unknown

Top  

Enumeration financialAccountJournalLineSourceTransaction

Nominal/General Journal (Opening Balance)

Nominal/General Journal (Default)

Nominal/General Journal (Allocation)

Nominal/General Journal (Default)

Nominal/General Journal (Prepayment)

Nominal/General Journal (Accrual)

Nominal/General Journal (Prior Year)

Nominal/General Journal (Cash/Bank Payment Taxable)

Nominal/General Journal (Cash/Bank Receipt Taxable)

Nominal/General Journal (Cash/Bank Payment Non-Taxable)

Nominal/General Journal (Cash/Bank Receipt Non-Taxable)

Nominal/General Journal (VAT/GST)

PL/AP Receipt (Default)

PL/AP Receipt (Check)

PL/AP Receipt (Voucher)

PL/AP Receipt (EFT)

PL/AP Receipt (BACS)

PL/AP Payment (Default)

PL/AP Payment (Check)

PL/AP Payment (Voucher)

PL/AP Payment (EFT)

PL/AP Payment (BACS)

PL/AP Invoice (Default)

PL/AP Invoice (Debit Memo)

PL/AP Invoice (Application for Payment)

PL/AP Credit (Default)

PL/AP Credit (Credit Memo)

PL/AP Invoice (Opening Balance)

PL/AP Credit (Opening Balance)

PO Purchase Order (Default)

PO Purchase Order (Blanket)

PO Purchase Order (Change)

PO Purchase Order (Voucher)

PO Purchase Requisition

PO Goods Received (Default)

PO Goods Despatched (Default)

PO Purchase Return (Default)

PO Goods Receipt (Warehouse)

SL/AR Receipt (Default)

SL/AR Receipt (Write Off)

SL/AR Receipt (Bad Debt)

SL/AR Receipt (Reversal)

SL/AR Payment (Default)

SL/AR Payment (Finance)

SL/AR Payment (Commission)

SL/AR Invoice (Default)

SL/AR Invoice (Debit Memo)

SL/AR Invoice (Application for Payment)

SL/AR Credit (Credit Memo)

SL/AR Credit (Default)

SL/AR Invoice (Opening Balance)

SL/AR Credit (Opening Balance)

SO Sales Order (Default)

SO Sales Order (Blanket)

SO Sales Order (Change)

SO Sales Quotation

SO Sales Return (Default)

SO Goods Despatched (Default)

SO Goods Received (Default)

SO Goods Despatched (Transfer)

SO Goods Received (Default)

SO Picking List (Default)

SO Goods Despatched (Bill of Lading)

Cash/Bank Payment Non-Taxable (Check)

Cash/Bank Payment Taxable (Check)

Cash/Bank Receipt Non-Taxable (Default)

Cash/Bank Payment Non-Taxable (Default)

Cash/Bank Payment Taxable (Default)

Cash/Bank Receipt Taxable (Default)

Cash/Bank Receipt Non-Taxable (Default)

Cash/Bank Bank Transfer (From)

Cash/Bank Bank Transfer (To)

Cash/Bank Payment Non-Taxable (Bank Charges)

Cash/Bank Receipt Non-Taxable (Interest)

Cash/Bank Payment Non-Taxable (Opening Balance)

Cash/Bank Receipt Non-Taxable (Opening Balance)

Stock/Inventory Transfer In (Default)

Stock/Inventory Transfer In (From Vendor/Supplier)

Stock/Inventory Transfer Out (Default)

Stock/Inventory Transfer Out (From Vendor/Supplier)

Stock/Inventory Sale Delivery

Stock/Inventory Sale Return

Stock/Inventory Purchase Delivery

Stock/Inventory Purchase Return

Stock/Inventory Issue (Default)

Stock/Inventory Issue (Return)

Stock/Inventory Issue (FOC)

Stock/Inventory Issue (Project)

Stock/Inventory Issue (Project Return)

Stock/Inventory Adjustment (Physical/Stocktake)

Stock/Inventory Adjustment (Default)

Stock/Inventory Adjustment (Addition)

Stock/Inventory Adjustment (Write Off)

Stock/Inventory Adjustment (Revaluation)

Stock/Inventory BOM Assembly (Default)

Stock/Inventory BOM Assembly (Component)

Stock/Inventory BOM Disassembly (Default)

Stock/Inventory BOM Disasembly (Component)

Stock/Inventory Transfer (Three Step)

Stock/Inventory Transfer (Default)

Stock/Inventory Adjustment (Opening Balance)

Payroll (Default)

Manufacturing WIP (Material)

Manufacturing WIP (Labor)

Manufacturing WIP (Progress)

Manufacturing WIP (Job Close)

Manufacturing Adjustment (Default)

Manufacturing WIP (Material Reversal)

Project/Job Debit (Default)

Project/Job Debit (Cost)

Project/Job Debit (Revenue)

Project/Job Credit (Default)

Project/Job Credit (Cost)

Project/Job Credit (Revenue)

Expense Claim

Warehouse

Point Of Sale/Retail

Nominal/General Journal (Consolidation)

Timesheet

Nominal/General Journal (Intercompany)

Nominal/General Journal (Fixed Assets)

Nominal/General Journal (Bill of Materials)

Nominal/General Journal (Pricing)

Nominal/General Journal (Import)

Nominal/General Journal (Not Specified)

Nominal/General Journal (Revaluation Gain GL)

Nominal/General Journal (Revaluation Loss GL)

Nominal/General Journal (Revaluation Gain AP)

Nominal/General Journal (Revaluation Loss AP)

Nominal/General Journal (Revaluation Gain AR)

Nominal/General Journal (Revaluation Loss AR)

Nominal/General Journal (Realized Gain)

Nominal/General Journal (Realized Loss)

Nominal/General Journal (Unknown)

Top  

Enumeration tenderTransactionType

Receipt

Authenticate Receipt

Deferred Receipt

Payment

Authenticate Payment

Deferred Payment

Top  

Enumeration tenderApplyEnum

0

1

2

3

Top  

Enumeration tenderAccountType

E

C

M

Top  

Enumeration tenderAVSCV2Response

ALL MATCH

SECURITY CODE MATCH ONLY

ADDRESS MATCH ONLY

NO DATA MATCHES

DATA NOT CHECKED

Top  

Enumeration tenderResult

NOTPROVIDED

NOTCHECKED

MATCHED

NOTMATCHED

Top  

Enumeration tender3DSecureStatus

OK

NOAUTH

CANTAUTH

NOTAUTHED

ATTEMPTONLY

NOTCHECKED

INCOMPLETE

MALFORMED

INVALID

ERROR

Top  

Enumeration tenderAddressStatus

NONE

CONFIRMED

UNCONFIRMED

Top  

Enumeration tenderPayerStatus

VERIFIED

UNVERIFIED

Top  

Enumeration tenderProfile

NORMAL

LOW

Top  

Enumeration businessDayOverrideFlag

None

Before

After